Skip to content

Latest commit

 

History

History
27 lines (17 loc) · 1.29 KB

RELEASING.md

File metadata and controls

27 lines (17 loc) · 1.29 KB
Raw

Release Process

There are certain parts about the process that could be automated better, pull requests are welcome.

  1. Pick a new version number according to semver. Note that we consider the configuration parameters part of unipipe service broker's "API". Note that we consider the commands and output part of unipipe cli's "API".

  2. Update the version number in these places:

    • cli/unipipe/info.ts

  3. Update CHANGELOG.md. We follow the guidelines from Keep a Changelog. It's recommended to add changes for the next version in a vNext section already together with pull requests, as this will make releasing a lot easier.

  4. Commit changes. Use the convention "Release vX.X.X” in your commit message. There shouldn’t be any other code changes.

  5. Tag the commit with the version number git tag vX.X.X

  6. Push the release tag git push origin --tags

  7. CI will run the release workflow and create a new GitHub Release.

  8. Manually edit the release on GitHub and paste the entries from CHANGELOG.md into the release description.