Skip to content

Latest commit

 

History

History
20 lines (15 loc) · 1.39 KB

CONTRIBUTING.md

File metadata and controls

20 lines (15 loc) · 1.39 KB
Raw

Ably SDK Team Upload Action: Contributing

Release Process

  1. Bump the version number in package.json
  2. Run npm install which will update the version in package-lock.json and also reveal whether there are any dependency vulnerabilities to be fixed
  3. Run npm run build to compile the TypeScript source code in to JS (output will be in lib/index.js, ignored by git)
  4. Run npm run package to compile the JS from step 1 into a single file (output will be in the dist folder)
  5. Commit the changes to the dist folder from step 4, alongside the version change from steps 1 and 2
  6. Update CHANGELOG.md
  7. Commit the change to the Changelog from step 6
  8. Push a tag with the absolute new version number to GitHub, which must be in the form v<major>.<minor>.<patch> - e.g. v1.3.0
  9. Move the tag for the major version number to the same commit, which will be in the form v<major> - e.g. v1

Commits made in steps 1 thru 7 should ideally be pushed to a release branch, seeking approval from others to land to main (default) branch prior to adding and moving tags.

See Also