Add workflow to run SDGym monthly and publish results

.github/workflows/readme.yml

@@ -27,5 +27,6 @@ jobs:
           python -m pip install --upgrade pip
           python -m pip install invoke rundoc .
           python -m pip install tomli
+          python -m pip install slack-sdk
     - name: Run the README.md
       run: invoke readme

.github/workflows/run_benchmark.yml

@@ -0,0 +1,34 @@
+name: Run SDGym Benchmark
+
+on:
+  push:
+    branches:
+      - issue-425-workflow-sdgym
+  workflow_dispatch:
+  schedule:
+    - cron: '0 5 5 * *'
+
+jobs:
+  run-sdgym-benchmark:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+    - name: Set up latest Python
+      uses: actions/setup-python@v5
+      with:
+        python-version-file: 'pyproject.toml'
+    - name: Install dependencies
+      run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e .[dev]
+
+    - name: Run SDGym Benchmark
+      env:
+        SLACK_TOKEN: ${{ secrets.SLACK_TOKEN }}
+        AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+        AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+        AWS_DEFAULT_REGION: ${{ secrets.AWS_REGION }}
+
+      run: invoke run-sdgym-benchmark

.github/workflows/upload_benchmark_results.yml

@@ -0,0 +1,101 @@
+name: Upload SDGym Benchmark results
+
+on:
+  workflow_run:
+    workflows: ["Run SDGym Benchmark"]
+    types:
+      - completed
+  workflow_dispatch:
+  schedule:
+    - cron: '0 6 * * *'
+
+jobs:
+  upload-sdgym-benchmark:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: Set up latest Python
+      uses: actions/setup-python@v5
+      with:
+        python-version-file: 'pyproject.toml'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install -e .[dev]
+
+    - name: Upload SDGym Benchmark
+      env:
+        AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+        AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+        GITHUB_LOCAL_RESULTS_DIR: ${{ runner.temp }}/sdgym-leaderboard-files
+      run: |
+        invoke upload-benchmark-results
+        echo "GITHUB_LOCAL_RESULTS_DIR=$GITHUB_LOCAL_RESULTS_DIR" >> $GITHUB_ENV
+
+    - name: Prepare files for PR
+      if: env.SKIP_UPLOAD != 'true'
+      run: |
+        mkdir pr-staging
+        echo "Looking for files in: $GITHUB_LOCAL_RESULTS_DIR"
+        ls -l "$GITHUB_LOCAL_RESULTS_DIR"
+        for f in "$GITHUB_LOCAL_RESULTS_DIR"/${FOLDER_NAME}_*.csv; do
+          base=$(basename "$f")
+          cp "$f" "pr-staging/${base}"
+        done
+
+        echo "Files staged for PR:"
+        ls -l pr-staging
+
+    - name: Checkout target repo (sdv-dev.github.io)
+      if: env.SKIP_UPLOAD != 'true'
+      run: |
+        git clone https://github.com/sdv-dev/sdv-dev.github.io.git target-repo
+        cd target-repo
+        git checkout gatsby-home
+
+    - name: Copy results and create PR
+      if: env.SKIP_UPLOAD != 'true'
+      env:
+        GH_TOKEN: ${{ secrets.GH_TOKEN }}
+        FOLDER_NAME: ${{ env.FOLDER_NAME }}
+      run: |
+        cp pr-staging/* target-repo/assets/sdgym-leaderboard-files/
+        cd target-repo
+        git checkout -b sdgym-benchmark-upload-${FOLDER_NAME}
+        git config --local user.name "github-actions[bot]"
+        git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
+
+        git add assets/
+        git commit -m "Upload SDGym Benchmark Results ($FOLDER_NAME)"
+        git remote set-url origin https://x-access-token:${GH_TOKEN}@github.com/sdv-dev/sdv-dev.github.io.git
+        git push origin sdgym-benchmark-upload-${FOLDER_NAME}
+
+        gh pr create \
+          --repo sdv-dev/sdv-dev.github.io \
+          --head sdgym-benchmark-upload-${FOLDER_NAME} \
+          --base gatsby-home \
+          --title "Upload SDGym Benchmark Results ($FOLDER_NAME)" \
+          --body "Automated benchmark results upload" \
+          --reviewer "pcarapic15"
+
+        # Capture PR URL
+        PR_URL=$(gh pr view sdgym-benchmark-upload-${FOLDER_NAME} \
+        --repo sdv-dev/sdv-dev.github.io \
+        --json url -q .url)
+
+        echo "PR URL: $PR_URL"
+        echo "PR_URL=$PR_URL" >> $GITHUB_ENV
+
+    - name: Send Slack notification
+      if: env.SKIP_UPLOAD != 'true'
+      env:
+        SLACK_TOKEN: ${{ secrets.SLACK_TOKEN }}
+      run: |
+        invoke notify-sdgym-benchmark-uploaded \
+          --folder-name "$FOLDER_NAME" \
+          --pr-url "$PR_URL"

pyproject.toml

@@ -83,6 +83,7 @@ test = [
     'pytest-cov>=2.6.0',
     'jupyter>=1.0.0,<2',
     'tomli>=2.0.0,<3',
+    'slack-sdk>=3.23,<4.0'
 ]
 dev = [
     'sdgym[dask, test]',
@@ -196,6 +197,7 @@ exclude = [
     ".ipynb_checkpoints",
     "tasks.py",
     "static_code_analysis.txt",
+    "*.ipynb"
 ]
 
 [tool.ruff.lint]