Skip to content

CI: add tag based release workflow and release version (v0.1.1)#32

Merged
Stefan Bruhns (sbruhns) merged 7 commits intomainfrom
release-flow
Mar 4, 2026
Merged

CI: add tag based release workflow and release version (v0.1.1)#32
Stefan Bruhns (sbruhns) merged 7 commits intomainfrom
release-flow

Conversation

@sbruhns
Copy link
Copy Markdown
Member

@sbruhns Stefan Bruhns (sbruhns) commented Feb 27, 2026

Summary

introduces a tag-based release process and update package/release documentation for maintainers.

What changed

  1. Added a new GitHub Actions workflow at .github/workflows/release.yml to publish on tags matching v*...
  2. Added release safeguards:
    • Fails if the tagged commit is not in main.
    • Fails if the tag version does not match package.json.
    • Runs build, lint, format check, and coverage tests before publish.
  3. Bumped package version from 0.1.0 to 0.1.1.
  4. Improved npm packaging metadata in package.json:
    • Added files allowlist (dist, README.md, LICENSE).
    • Added clean, updated build, and prepack scripts.
    • Added repository metadata.
  5. Updated TypeScript config to exclude test files from build output.
  6. Added maintainer docs:
    • docs/developer/README.md
    • docs/developer/running.md
    • docs/developer/releasing.md
    • Linked these from the root README.md.

Why

  • Standardize and secure npm releases with trusted publishing.
  • Ensure releases are traceable to main and version-consistent.
  • Clarify local-dev vs published-package usage and release steps for maintainers.

Comment thread tsconfig.json Outdated
Comment thread package.json Outdated
Comment thread docs/developer/releasing.md Outdated
Comment thread .github/workflows/release.yml Outdated
Stefan Bruhns (sbruhns) and others added 3 commits March 2, 2026 13:48
@sbruhns Stefan Bruhns (sbruhns) merged commit b40f869 into main Mar 4, 2026
1 check passed
@sbruhns Stefan Bruhns (sbruhns) deleted the release-flow branch March 4, 2026 10:44
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