Releasing
Changesets
Section titled “Changesets”Every change to a published package needs a changeset describing it for the changelog:
pnpm changesetPick the packages, the kind of bump (patch, minor or major) and write one or two sentences for users. Commit messages follow Conventional Commits.
How a release happens
Section titled “How a release happens”- Merged changesets collect in a Version Packages pull request opened by the release workflow.
- Merging that pull request publishes the packages to npm with provenance, using npm trusted publishing (no npm token is stored in the repository).
- The collector image is built, signed and pushed to the GitHub Container Registry with full, minor and major version tags.
What a version number promises
Section titled “What a version number promises”Within a major version, nothing covered by semantic versioning breaks: the packages’ exported APIs (recorded in each
package’s etc/*.api.md report), the CLI, the collector’s HTTP API and environment variables, and data in an existing
database. A breaking change needs a major changeset and a migration note. The wire format has its own major version,
and a collector accepts the current and the previous one. The full list is in
ADR 0017.