Skip to content

fix(ci): dispatch docs changelog sync after publish#313

Merged
sanjeed5 merged 2 commits intofederated-sdk-release-candidatefrom
fix/sdk-docs-sync-after-publish
Mar 9, 2026
Merged

fix(ci): dispatch docs changelog sync after publish#313
sanjeed5 merged 2 commits intofederated-sdk-release-candidatefrom
fix/sdk-docs-sync-after-publish

Conversation

@sanjeed5
Copy link
Contributor

@sanjeed5 sanjeed5 commented Mar 9, 2026

Summary

  • trigger sync-changelog-to-docs.yml explicitly from sdk-publish.yml after a new release is published
  • add actions: write so the publish workflow can dispatch the follow-up workflow with the released version
  • avoid relying on release event fan-out, which does not run when the release is created by github-actions[bot] via GITHUB_TOKEN

Test plan

  • Run uv sync --extra dev --extra docs
  • Run make generate && make format
  • Trigger Publish to PyPI in GitHub Actions and confirm it dispatches Sync SDK Release to Docs

Trigger the docs changelog sync workflow directly from the publish workflow so SDK releases created by github-actions still update docs. This avoids relying on release event fan-out that does not run for releases created with GITHUB_TOKEN.
@sanjeed5 sanjeed5 requested a review from a team March 9, 2026 21:30
@snyk-io
Copy link

snyk-io bot commented Mar 9, 2026

Snyk checks have passed. No issues have been found so far.

Status Scanner Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues
Licenses 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@claude
Copy link
Contributor

claude bot commented Mar 9, 2026

Claude finished @sanjeed5's task in 50s —— View job


PR Review: fix(ci): dispatch docs changelog sync after publish

  • Gather context and read changed files
  • Review workflow changes
  • Post feedback

Verdict: Looks good overall. This is a clean, well-scoped CI fix. The approach of explicitly dispatching the docs sync workflow (instead of relying on release event fan-out from GITHUB_TOKEN-created releases) is the correct solution.

What looks good

  • The actions: write permission is correctly scoped to enable gh workflow run
  • The if: steps.check_pypi.outputs.exists == 'false' guard ensures the dispatch only fires on actual new publishes
  • The version input passed to the target workflow matches the workflow_dispatch.inputs.version definition in sync-changelog-to-docs.yml

Minor observations

  1. SYNC_REF fallback on push events (line 405): When the workflow triggers via push to main (not workflow_dispatch), github.event.inputs.branch is empty/null, so SYNC_REF falls back to github.ref_name which will be main. This is correct behavior, just calling it out as confirmed.

  2. No error handling on dispatch failure: If gh workflow run fails (e.g., target workflow file is missing or renamed), this step will fail the entire publish job after the package has already been published to PyPI and the GitHub release created. This is probably acceptable since the important work is already done, but you could consider adding continue-on-error: true to make the dispatch step non-blocking if you want the publish job to always report success once PyPI publish succeeds.

  3. Hardcoded workflow filename: The dispatch references sync-changelog-to-docs.yml by filename. If that file is ever renamed, this will silently break. A comment noting the coupling would be helpful, but not critical.

No blocking issues found — this is good to merge.

@sanjeed5 sanjeed5 merged commit da4f2bd into federated-sdk-release-candidate Mar 9, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants