Skip to content

Latest commit

 

History

History
38 lines (32 loc) · 2.21 KB

PUBLISHING.md

File metadata and controls

38 lines (32 loc) · 2.21 KB
Raw

Publishing

We use GitHub Actions to publish new versions of this repository from tags. In general, this includes some prepublish steps like updating versions in various *.json files, committing those changes, and tagging the resulting commit. These steps can be done manually, or via the bump script. Follow whichever procedure feels more comfortable. By publishing, the “Publish” GitHub Action workflow will be triggered and if all the tests pass, it’ll publish to all the registries we care about.

Before you start — make sure your on the main branch and up to date. E.g., by running git checkout main && git pull origin main.

Publishing with Manual Prepublish

  1. Edit package.json, package-lock.json, and deno.json files to set the new version. Don’t forget that package-lock.json should be edited in multiple places to account for the self-package’s version (i.e., ""). For example, set the "version" key to a value of "1.0.0-rc.57".
  2. Add / commit those files. By convention, set the message to the new version (e.g., git commit --message="1.0.0-rc.57").
  3. Tag the commit using an annotated tag. By convention, set the name to the new version prefixed with a “v” and set the message to the new version (e.g., git tag --annotate "v1.0.0-rc.57" --message="1.0.0-rc.57").
  4. Push the new commit / tags by running git push origin main --follow-tags.
  5. Find the tag you just pushed in the GitHub UI and click the “Create release” option. Add any additional release information (including to check the box if it’s a “pre-release”).

Publishing with Assisted Prepublish (bump)

  1. Run npm run bump to view the current version. Then, run the same command and provide the version to bump to (e.g., npm run bump 1.0.0-rc.57). Note, keywords like major, minor, patch, etc. are supported.
  2. Push the new commit / tags by running git push origin main --follow-tags.
  3. Find the tag you just pushed in the GitHub UI and click the “Create release” option. Add any additional release information (including to check the box if it’s a “pre-release”).