Skip to content

ci(release): notify the docs repo so CLI releases get release notes - #46

Merged
a-c-wagner merged 2 commits into
mainfrom
doc-andy/notify-docs-on-release
Nov 9, 2026
Merged

a-c-wagner merged 2 commits into
mainfrom
doc-andy/notify-docs-on-release

Conversation

@a-c-wagner

Copy link
Copy Markdown
Contributor

Summary

CLI releases don't get release notes on the docs site today, because nothing tells the docs repo a CLI release happened. Backend and frontend send a release repository dispatch to dualentry/docs when they publish; this adds the same dispatch to the CLI release workflow so v0.1.22 onward gets notes automatically.

The docs side is already in place: dualentry/docs#1156 limits the wiki rebuild to backend and frontend, so a CLI release only produces release notes.

Changes

  • New notify-docs job in .github/workflows/release.yml, after upload:
    • skips prereleases;
    • creates a GitHub App token scoped to dualentry/docs with contents: write, using the same app credentials the workflow already uses;
    • sends event_type: release with client_payload {repo: dualentry-cli, release_tag: <tag>};
    • continue-on-error: true, so a docs-side problem never fails a release;
    • permissions: {} for the job's own GITHUB_TOKEN.

Test plan

  • actionlint passes on .github/workflows/release.yml.
  • Next CLI release: the notify-docs job succeeds and a "Process Release" run starts in dualentry/docs with repo: dualentry-cli.
  • That run's wiki job is skipped and a release-notes PR follows.

Artifacts

No src/ changes, so nothing to run against the API.

Add a notify-docs job that sends the same `release` repository_dispatch
to dualentry/docs that backend and frontend send through release-cycle,
with repo `dualentry-cli` and the release tag. It runs after the
binaries upload, skips pre-releases, and can't fail the release.
Comment thread .github/workflows/release.yml Resolved
@a-c-wagner
a-c-wagner requested review from atrsa and xSAVIKx November 9, 2026 20:53
@a-c-wagner
a-c-wagner merged commit 60b6232 into main Nov 9, 2026
6 checks passed
@a-c-wagner
a-c-wagner deleted the doc-andy/notify-docs-on-release branch November 9, 2026 21:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants