Skip to content

Latest commit

 

History

History
18 lines (13 loc) · 1.08 KB

RELEASES.md

File metadata and controls

18 lines (13 loc) · 1.08 KB
Raw

RTV.js Releases

The release/publishing process is as follows:

  1. Checkout master, rebase, and make sure it's in a clean state with no pending commits not yet pushed to origin.

  2. Move all entries under the UNRELEASED section in the /CHANGELOG.md into a new version section matching the version number that will be released.

    • Include the release date in the new section.
    • Remove the UNRELEASED section.

  3. Commit changes to /CHANGELOG.md using a commit message like "Changes for version x.y.z".

  4. Run npm run release:<major|minor|patch>. This script will first version /package.json and the repo, and will then publish the new release to npm (as long as tests, the build, and docs succeed). It will also push the CHANGELOG commit, along with the package.json version update and release tag, up to origin.

    For example, to release a new minor version, run

    $ npm run release:minor

  5. Update the documentation site: Happens automatically on merge to master branch.