Skip to content

releasing.md

Latest commit

 

History

History
201 lines (148 loc) · 5.49 KB

releasing.md

File metadata and controls

201 lines (148 loc) · 5.49 KB
Raw

Releasing

CodeDecay publishes one npm package for v1:

@submuxhq/codedecay

The package source is packages/cli, and the installed binary remains codedecay.

CodeDecay also publishes an optional GitHub Packages npm mirror with the same package name. GitHub Packages scopes packages by GitHub user or organization owner, and this repository is owned by SubmuxHQ, so every release from v0.2.0 onward uses @submuxhq/codedecay for both npmjs and the GitHub Packages mirror.

npmjs is the default public install path for users:

npm install -D @submuxhq/codedecay

GitHub Packages is an authenticated mirror for GitHub-based workflows and requires registry authentication for installs.

Patch Release Checklist

Before opening the release PR, bump the published version in:

  • packages/cli/package.json
  • packages/core/src/version.ts
  • judge-lab/lib/source.ts when the Judge Lab links to the tagged release

Regenerate versioned Judge Lab evidence after the package/core bump:

pnpm judge-lab:evidence

After the release PR is merged, release only from a clean main branch at the commit that will be tagged and published. Do not publish npm contents from a different commit than the Git tag.

Run:

pnpm install
pnpm run lint
pnpm typecheck
pnpm test
pnpm build
pnpm --filter @submuxhq/codedecay pack --dry-run
pnpm test:child-repo-e2e -- --run-id release-candidate

The child-repository acceptance gate packs and installs the CLI outside the workspace, runs real configured checks, launches Chromium against a local child application, exercises generated Playwright tests, and verifies MCP, Action, differential, and repair-loop workflows. Treat a skipped browser or loop path as missing release evidence, not a pass.

Inspect the tarball before publishing:

pnpm --filter @submuxhq/codedecay pack
tar -tzf submuxhq-codedecay-<version>.tgz

The tarball must include:

package/LICENSE
package/README.md
package/package.json
package/dist/index.js
package/dist/index.d.ts

Before publishing, run the installed-package smoke against the packed tarball:

pnpm demo:published-package --tarball ./submuxhq-codedecay-<version>.tgz --run-id v<version>-tarball-smoke

This creates a fresh temp install, materializes the Next.js and Node API demo repos, runs the installed codedecay binary, verifies JSON/Markdown/SARIF outputs, and writes logs under:

.codedecay/local/published-package-demo/<run-id>/run.json
.codedecay/local/published-package-demo/<run-id>/summary.md

Publish the scoped package with public access:

pnpm --filter @submuxhq/codedecay publish --access public

If npm requires a one-time password in a non-interactive shell, publish from the package directory:

cd packages/cli
npm publish --access public --otp <otp>

After publishing, verify the public install path:

tmpdir=$(mktemp -d)
cd "$tmpdir"
npm install @submuxhq/codedecay@<version>
node_modules/.bin/codedecay --help

After publishing, run the same smoke against the registry package:

pnpm demo:published-package --package @submuxhq/codedecay@<version> --run-id v<version>-published-smoke

Create the GitHub release for the same tag and verify the release surfaces stay in sync:

git show --no-patch --decorate --oneline v<version>
gh release view v<version>
npm view @submuxhq/codedecay version dist-tags --json

The package version, npm latest dist-tag, Git tag, and GitHub release should all refer to the same released version before the release is considered done.

GitHub Packages Mirror

The GitHub Packages mirror is published from the same built CLI package. It uses the same package name, @submuxhq/codedecay, and sets the registry to https://npm.pkg.github.com.

Use npmjs for public end-user installs. Use GitHub Packages only when a workflow or organization policy specifically needs a GitHub-hosted package mirror.

Prepare the mirror package locally after pnpm build:packages:

pnpm package:github --out /tmp/codedecay-ghpkg
cd /tmp/codedecay-ghpkg
npm pack --dry-run

The dry run should include:

package/LICENSE
package/README.md
package/package.json
package/dist/index.js
package/dist/index.d.ts

Publish through the Publish GitHub Packages workflow. It uses the repository GITHUB_TOKEN with packages: write permission and skips publishing if the same mirror version already exists.

Use the exact release tag as the workflow ref. Do not publish from main after unreleased commits have landed, because that can create a GitHub Packages version whose contents differ from the npmjs package with the same version.

Manual dispatch:

gh workflow run publish-github-packages.yml -f ref=v<version>

Install from GitHub Packages by adding the GitHub owner scope and an authenticated token to .npmrc:

@submuxhq:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=<classic-pat-with-read:packages>

Then install:

npm install -D @submuxhq/codedecay@<version>
node_modules/.bin/codedecay version

GitHub Packages requires a personal access token classic with read:packages for local installs. GitHub Actions can use GITHUB_TOKEN when the package is associated with this repository and the workflow has package access.

If local verification fails with 403 permission_denied, check the token scope before changing package metadata. The default public npmjs install path should still work without GitHub authentication:

npm install -D @submuxhq/codedecay