Skip to content

Latest commit

 

History

History
38 lines (29 loc) · 1.72 KB

RELEASE.md

File metadata and controls

38 lines (29 loc) · 1.72 KB

Releasing shirokuma

This is an example for publising version 1.2.0.

Checks and preparations

  1. Check that the CI has passed on the shirokuma project's Github page.
  2. Make sure you are on the main branch.
  3. Make sure to run npm install to have the latest dependencies installed
  4. Run the test suites and make sure all tests pass: npm run test and also test npm run build
  5. Make sure that all examples in the README.md are still up-to-date with the latest API changes.

Changelog time!

  1. Check the git history for any commits on main that have not been mentioned in the Unreleased section of CHANGELOG.md but should be.
  2. Add an entry in CHANGELOG.md for this new release and move over all the Unreleased stuff. Follow the formatting given by previous entries.
  3. Remember to update the links to your release and the unreleased git log at the bottom of CHANGELOG.md.

Tagging and versioning

  1. Change the examples in the README.md which import shirokuma by version to use the latest version
  2. Bump the package version in package.json using npm version [major|minor|patch] (this is using semantic versioning).
  3. Push your changes including your tags using git push origin main --tags.

Publishing releases

  1. Copy the changelog entry you authored into Github's new release page's description field. Title it with your version v1.2.0.
  2. Run npm run build.
  3. Run npm pack --dry-run to check the file listing you are about to publish doesn't contain any unwanted files.
  4. Run npm publish and check the window for any birds outside your window.