Skip to main content
Version: 0.30.0-beta.8

Publishing NitromelonDB

Releases are done with GitHub Actions. Do not publish to npm from your laptop.

Full details: .github/workflows/README.md.

Step 1: Keep CHANGELOG-Unreleased.md current​

Every merged change should already have a note there. Prepare Release copies those notes into CHANGELOG.md automatically. Graduating an alpha/beta to stable also folds that version's prerelease changelog sections into one official entry.

Step 2: Prepare the release​

  1. GitHub → Actions → Prepare Release
  2. Run the workflow from master
  3. Choose:
    • Version bump: none / promote / patch / minor / major (none keeps the current X.Y.Z; promote ships the in-progress alpha/beta as official X.Y.Z)
    • Prerelease: none / alpha / beta (ignored when bump is promote)
    • npm dist-tag: none / latest / alpha / beta (none is default behavior: alpha→alpha, beta→beta, official→latest)

To ship another alpha of the same version: bump none + prerelease alpha (0.30.0-alpha.0 → 0.30.0-alpha.1). To graduate that line: bump promote. Choosing prerelease none on an in-progress alpha/beta also publishes that version as stable.

Leave npm dist-tag on none unless this version should become what npm i nitromelondb installs. Do not put every beta on latest after a stable exists.

Step 3: Review and merge the PR​

The workflow opens a release/v… PR with the version bump and changelog. CI runs on that PR. Merge when it looks right.

Step 4: Automatic publish​

Merging the PR pushes the release commit to master, which runs Publish Release:

  • Builds dist/
  • Publishes nitromelondb to npm (latest, alpha, or beta, unless Prepare recorded an override)
  • Creates the git tag and GitHub Release

If npm publish fails, do not run Prepare Release again. Run Actions → Publish Release from master to retry the same version.

Local helpers​

# Preview the next version without changing files
node scripts/next-version.mjs minor alpha

# Version calculator and changelog-fold tests
node scripts/next-version.mjs --self-test
node scripts/prepare-changelog.mjs --self-test

The interactive yarn release script is legacy. Use Actions instead.

npm authentication​

No NPM_TOKEN secret. Releases authenticate with npm trusted publishing (OIDC).

One-time: if nitromelondb is not on npm yet, publish once from your machine (yarn build && npm publish ./dist --otp=…), then on package access settings add a GitHub Actions trusted publisher:

  • Organization or user: StasDoskalenko
  • Repository: NitromelonDB
  • Workflow filename: publish-release.yml (filename only)
  • Environment: leave empty
  • Allowed actions: npm publish

After the first Actions publish works, set Require two-factor authentication and disallow tokens on that same page. Details: .github/workflows/README.md.