Files
hyperframes/docs/contributing/release-channels.mdx
T
Miguel Ángel 5f46379775 fix(publish): upload only what npm reads as checked; tags publish only main, next or alpha commits (#7959)
* fix(publish): upload only what npm reads as checked, and tag-publish only main commits

npm reads tarballs with node-tar, which can resolve a header differently from the GNU tar
check. A dry run of the same npm now has to agree on name, version and files before anything
is written. A v*-* tag now builds only a commit already on main.

* fix(publish): a v*-* tag publishes a commit on main, next or alpha

Alphas stay cut from next or alpha as release-channels.mdx says; a commit on none of them is
refused before any job builds it, and the error names it as not an ancestor of those branches.

* style(publish): wrap the npm check comment under the 120-column limit
2026-11-16 17:13:42 +00:00

79 lines
4.9 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
title: Release channels
description: How HyperFrames keeps alpha-only work out of stable releases.
---
HyperFrames publishes two release channels:
- Stable releases use versions like `0.4.24` and publish to the npm `latest` dist-tag.
- Prereleases use versions like `0.4.24-alpha.1` and publish to the npm dist-tag named by the prerelease suffix, such as `alpha`.
## Branch policy
Use branch separation to decide what code is eligible for each release channel.
Dist-tags only control npm install defaults; they do not remove code from a package.
- `main` is stable/releasable. Anything merged to `main` is eligible for `latest`.
- `release/v*` branches are for stable patch releases and hotfixes.
- `next`, `alpha`, `beta`, `rc`, `canary`, and `prerelease/*` branches are for prerelease integration.
If a feature should ship in alpha only, merge or retarget that PR to a prerelease branch instead of `main`.
## Stable release
Stable releases publish only when a reviewed `release/vX.Y.Z` PR merges into protected `main`.
Prepare and review release notes before creating the release commit:
```bash
bun run release:prepare <version>
```
On the first run, `release:prepare` drafts missing changelog artifacts and exits non-zero for review so chained release commands stop before tagging. After the generated TODO summary is rewritten, rerun the same command to create the release commit and tag.
See [Changelog process](/contributing/changelog-process) for the full workflow. For stable releases, `bun run set-version <version>` still enforces this checkpoint when maintainers run the lower-level release command directly.
Push the release branch without its local tag, open a PR to `main`, and merge it after approval and CI. The publish workflow checks out the exact PR merge SHA, verifies it before publishing, creates the stable tag at that commit, publishes npm packages, and creates the GitHub release. Before it publishes, the run waits for a maintainer to approve it in the `npm-publish` environment.
If that workflow needs recovery, rerun its original merged-PR event. Stable tag pushes and manual dispatches do not publish, so recovery cannot select a different commit.
For hotfixes, branch from the last stable tag, cherry-pick only the fix, publish the patch release, then merge or cherry-pick the same fix back into the prerelease branch.
## Alpha release
Alpha releases must be reachable from `origin/main`, `origin/next` or `origin/alpha`. The publish workflow refuses a tag on any other commit before it builds anything.
Use the same changelog draft workflow when the prerelease contains changes that users should know about.
```bash
git checkout next
bun run set-version 0.4.25-alpha.1
git push origin next
git push origin v0.4.25-alpha.1
```
The tag push starts the publish workflow. It builds and packs the release, then waits for approval in the `npm-publish` environment. A maintainer other than the person who pushed the tag approves the run on the workflow page, and only then is anything published. A prerelease branch has no PR review, so this approval is its review.
Consumers can install alpha builds explicitly:
```bash
npm install hyperframes@alpha
npm install @hyperframes/core@alpha
```
## CI guardrails
The publish workflow validates release channel boundaries before publishing:
- Stable versions must publish with `latest`.
- Prerelease versions must publish with the prerelease dist-tag, such as `alpha`.
- Stable releases must come from a merged, reviewed `release/vX.Y.Z` PR.
- Prerelease tags must point at a commit already on `main`, `next` or `alpha`.
- Every publish, stable or prerelease, waits for a maintainer other than the one who started it to approve the run in the `npm-publish` environment.
- Merged `release/vX.Y.Z` PRs publish stable releases only.
- Every publish job verifies that its checkout matches the immutable event SHA.
- Builds, lifecycle scripts and `npm pack` run in a job with a read-only token and no secrets.
- The job that holds the npm token runs no code from the release commit. It checks that every packed tarball is a package this workflow publishes, at exactly the release version, then uploads it with lifecycle scripts off.
- A version already on npm is skipped only when its contents match the original run’s tarball, including on a retry. Different contents fail the publish.
- The Lambda handler zip and arm64 video image are built by the run, and `@hyperframes/aws-lambda` pins those builds. Retries reuse the original immutable run bundle. If the version is already on npm, its verified package must pin those same bytes before any release mutation. A separate immutable run receipt binds the release ID and asset digests; foreign releases and mismatched assets fail instead of being adopted or overwritten. See [publish recovery](/contributing/changelog-process) for retention and recovery limits.
This prevents an alpha-only feature from being included in a stable hotfix by accident.