Skip to content

feat: integrate release-doc-sync to keep release docs aligned#7

Merged
TMHSDigital merged 1 commit intomainfrom
feat/integrate-release-doc-sync
Apr 25, 2026
Merged

feat: integrate release-doc-sync to keep release docs aligned#7
TMHSDigital merged 1 commit intomainfrom
feat/integrate-release-doc-sync

Conversation

@TMHSDigital
Copy link
Copy Markdown
Owner

Integrates the release-doc-sync@v1.0 composite action into release.yml. After plugin.json is bumped on auto-release, the action prepends a stub entry to CHANGELOG.md for the new version.

This repo does not ship CLAUDE.md or ROADMAP.md, so the action's CLAUDE/ROADMAP edits are no-ops here (the action reports them as missing and exits cleanly).

One small adjustment to git add

This repo's existing "Commit version bump" step uses

git add .cursor-plugin/plugin.json README.md

rather than the git add -A pattern used by Docker / Steam / Home-Lab / Monday. To make sure the action's CHANGELOG prepend actually lands in the release commit, this PR adds CHANGELOG.md to that list:

git add .cursor-plugin/plugin.json README.md CHANGELOG.md

Without this change the action would run successfully but its sole useful output for this repo would be silently discarded.

Phase 2c parallel rollout following the Docker smoke test (verified at v1.8.2 of release-doc-sync).

The PR's own CI does not exercise release-doc-sync directly. Validation happens on the next auto-release post-merge.

Refs TMHSDigital/Developer-Tools-Directory#5.

Adds the release-doc-sync@v1.0 composite action from the meta-repo
to release.yml. After plugin.json is bumped on auto-release, the
action prepends a stub entry to CHANGELOG.md for the new version.

This repo does not ship CLAUDE.md or ROADMAP.md, so the action's
CLAUDE/ROADMAP edits are no-ops here (the action reports them as
"missing" and exits cleanly).

The existing "Commit version bump" step uses a selective
`git add .cursor-plugin/plugin.json README.md` rather than
`git add -A`, so CHANGELOG.md is added to that list to ensure the
prepended entry actually lands in the release commit. Without this
change the action would run but its sole useful output (the
CHANGELOG prepend) would be silently discarded.

Phase 2c rollout following the Docker smoke test pattern. The action
is verified working at v1.8.2 (pinned via @v1.0 floating tag).

Refs TMHSDigital/Developer-Tools-Directory#5.

Signed-off-by: 154358121+TMHSDigital@users.noreply.github.com
@github-actions github-actions Bot added the ci label Apr 25, 2026
@TMHSDigital TMHSDigital merged commit f844dcb into main Apr 25, 2026
12 checks passed
@TMHSDigital TMHSDigital deleted the feat/integrate-release-doc-sync branch April 25, 2026 15:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant