Skip to content

ci+docs: auto-create GitHub Releases from CHANGELOG + README npm link - #20

Merged
goodlime merged 1 commit into
mainfrom
docs/release-notes-automation
Jun 21, 2026
Merged

ci+docs: auto-create GitHub Releases from CHANGELOG + README npm link#20
goodlime merged 1 commit into
mainfrom
docs/release-notes-automation

Conversation

@goodlime

Copy link
Copy Markdown
Contributor

What

Follow-up housekeeping after the v2.0.0-beta.2 release.

publish.yml — release notes baked into the process

On every v* tag push, a new Create GitHub Release step extracts that version's section from CHANGELOG.md (Keep a Changelog format) and creates the GitHub Release — marked pre-release for -alpha/-beta/-rc, falling back to GitHub's auto-generated notes if no CHANGELOG section exists. No more bare, noteless tags. Adds contents: write (needed for gh release create); the npm publish step is unchanged.

The step only runs on a tag push, so this PR's CI doesn't exercise it. The extraction + gh release create --notes-file mechanic was already proven by hand creating the retroactive beta.1 / beta.2 releases; first real exercise on the runner is the next tag.

CHANGELOG.md

Lead the 2.0.0-beta.2 entry with a headline framing the @grapesjs/react-parity restructure.

README.md

  • Explicit npm package link up top (previously only a shields badge).
  • Install line uses @beta — the newest build ships under the beta dist-tag, so a plain npm install currently resolves to an older beta.

Note

The two existing tags already have GitHub Releases (created retroactively from these same CHANGELOG sections).

- publish.yml: on each v* tag, extract that version's CHANGELOG section
  and create a GitHub Release (pre-release for -alpha/-beta/-rc), so tags
  never ship without notes again. Needs contents: write.
- CHANGELOG: lead the 2.0.0-beta.2 entry with the @grapesjs/react-parity
  restructure headline.
- README: add an explicit npm package link and install via @beta (the
  newest build ships under the beta dist-tag).
@goodlime
goodlime merged commit 8cc095c into main Jun 21, 2026
1 check passed
@goodlime
goodlime deleted the docs/release-notes-automation branch June 21, 2026 14:52
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.

1 participant