Skip to content
K.J. Valencik edited this page Jan 6, 2021 · 8 revisions

These are the steps for publishing a new release of Neon:

Update release notes
  • Update the release notes in RELEASES.md.
  • Update the authors list in AUTHORS.md with any new contributors.
Bump version numbers
  • Run ./dev/bump.sh patch
  • Visually verify the printed diff
Validate the repo
  • Run ./dev/validate.sh
  • Ensure the validation passed
Commit, push, and release on GitHub
  • Run ./dev/commit.sh dherman
  • Input personal access token when prompted
Publish
  • Run ./dev/publish.sh

Steps to manually publishing N-API pre-release

The following should be performed prior to the full release.

  1. In Cargo.toml:
    1. append -napi to the release number: a.b.c-napi.
    2. Change the default feature flag to napi-experimental
    3. Remove [workspace] section
    4. Change docs.rs features to features = ["napi-experimental", "event-queue-api", "proc-macros", "try-catch-api"]
    5. Add no-default-features = true to docs.rs section
  2. cargo publish --no-verify --allow-dirty to publish with unstaged files
  3. Reset changes with git checkout --hard