gx2 1.1.1.dev0__tar.gz → 1.2__tar.gz

{gx2-1.1.1.dev0 → gx2-1.2}/.github/workflows/publish.yml

@@ -24,17 +24,6 @@ jobs:
         with:
           python-version: "3.x"
 
-      - name: Regenerate getting-started docs from the notebook
-        # Re-runs GettingStarted.ipynb and refreshes getting-started/*.png and
-        # the README's worked-examples section from its output, so the
-        # published README always reflects a fresh run of the notebook. This
-        # is best-effort and never blocks the release -- if the notebook
-        # itself is out of date, keeping it current is on the maintainer.
-        run: |
-          python -m pip install -e ".[docs]"
-          python -m ipykernel install --user --name python3
-          python scripts/build_getting_started.py
-
       - name: Build sdist and wheel
         run: |
           python -m pip install --upgrade build

gx2-1.2/.github/workflows/regen-docs.yml

@@ -0,0 +1,47 @@
+name: Sync getting-started docs from notebook
+
+# Whenever GettingStarted.ipynb changes on main, copy its current (already
+# rendered) outputs into README.md and getting-started/*.png, and commit the
+# result back to main. This does NOT re-execute the notebook -- it only
+# reflects whatever state you last saved it in, so this step stays fast.
+#
+# Pushes made with the default GITHUB_TOKEN don't trigger new workflow runs,
+# so the commit this job makes won't cause an infinite loop.
+on:
+  push:
+    branches: [main]
+    paths:
+      - GettingStarted.ipynb
+
+permissions:
+  contents: write
+
+jobs:
+  regen-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: main
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Install dependencies
+        run: python -m pip install nbformat
+
+      - name: Sync README and images from the notebook
+        run: python scripts/build_getting_started.py --no-execute
+
+      - name: Commit and push if changed
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add README.md getting-started/
+          if git diff --cached --quiet; then
+            echo "No changes to commit"
+          else
+            git commit -m "docs: sync getting-started assets from notebook"
+            git push origin HEAD:main
+          fi

{gx2-1.1.1.dev0 → gx2-1.2}/.gitignore

@@ -6,3 +6,4 @@ __pycache__/
 *.py[cod]
 .pytest_cache/
 .ipynb_checkpoints/
+tests/bench_out