ci(release): notify docs to regenerate the API reference on release (#169)

rahlk · web-flow · commit c932937b2383 · 2026-06-27T15:39:23.000-04:00
After publishing to GitHub and PyPI, send a repository_dispatch (sdk-release) to
codellm-devkit/docs carrying the released tag, so the docs repo regenerates and
opens a PR for the Python API reference matched to this version.

Requires a DOCS_DISPATCH_TOKEN secret: a PAT/fine-grained token with
contents:write on codellm-devkit/docs.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -126,3 +126,15 @@ jobs:
 
       - name: Publish package distributions to PyPI
         run: uv publish --token ${{ secrets.PYPI_API_TOKEN }}
+
+      - name: Trigger docs API-reference update
+        # After a successful release, tell the docs repo to regenerate and PR the
+        # Python API reference against this tag. Requires a DOCS_DISPATCH_TOKEN
+        # secret: a PAT (or fine-grained token) with contents:write on
+        # codellm-devkit/docs. See docs-astro .github/workflows/update-api-docs.yml.
+        uses: peter-evans/repository-dispatch@v3
+        with:
+          token: ${{ secrets.DOCS_DISPATCH_TOKEN }}
+          repository: codellm-devkit/docs
+          event-type: sdk-release
+          client-payload: '{"ref": "${{ github.ref_name }}"}'
