Skip to content

RELEASING.md

Latest commit

 

History

History
34 lines (26 loc) · 1.54 KB

RELEASING.md

File metadata and controls

34 lines (26 loc) · 1.54 KB
Raw

Releasing

Releases are published from wangxpych/optimistic-reconcile by .github/workflows/publish.yml using npm Trusted Publishing. The workflow uses short-lived OIDC credentials and does not require a stored npm token.

Current release state

Version 0.1.0 was published manually on 2026-08-29 to establish the package name before Trusted Publishing could be configured. Its registry metadata, package archive, clean installation, ESM import, core reconciliation flow, and zero-vulnerability audit were verified after publication.

The npm package now trusts only the publish.yml workflow in wangxpych/optimistic-reconcile for GitHub Actions publishing. Direct publishing requires two-factor authentication, and automation tokens cannot bypass that requirement.

Do not create a GitHub Release for v0.1.0: that version is already present on npm, so the publish workflow would correctly reject the duplicate. The next GitHub Release must use a newer version.

Release procedure

  1. Update package.json and CHANGELOG.md.
  2. Update affected API, architecture, and migration documentation.
  3. Run pnpm release:check and pnpm demo.
  4. Inspect the package archive and install it in a clean temporary project.
  5. Merge to main and confirm required CI checks pass.
  6. Publish a non-prerelease GitHub Release tagged v<package version>.
  7. Verify npm registry metadata, provenance, clean installation, and ESM import.

The publish workflow rejects tags that do not match package.json. Do not create a GitHub Release for a version already present on npm.