Skip to content

RELEASING.md

Latest commit

 

History

History
23 lines (20 loc) · 1.4 KB

RELEASING.md

File metadata and controls

23 lines (20 loc) · 1.4 KB

Releasing

  1. Create a branch named branch-<major>.<minor>.x if not already exists from master. Example branch name branch-3.0.x. All subsequent release for this release cycle should be done on this branch. All further steps are to be done on this branch.
  2. Add release notes (notes/<version>.markdown)
  3. Update top-level CHANGELOG.md
  4. Update top-level README.md
  5. Update CSW_VERSION, ESW_VERSION in .github/workflow/release.yml & Libs file which points to the latest compatible version
  6. Update embedded-keycloak, csw and esw version in Libs.scala
  7. Update version number in lib/package.json
  8. Update CSW and ESW versions in shell.ts
  9. Update <****> with the version in release.yml NPM publish step. For ex: If you are publishing 1.0.0 Replace <****> with the corresponding tag i.e v1.0.0.
  10. Commit and push the changes to branch-<major>.<minor>.x branch. Ensure that pipeline is green.
  11. Run release.sh $VERSION$ script by providing version number argument (This triggers release workflow) Note: PROD=true environment variable needs to be set before running release.sh

After release pipeline is green:

  1. Verify ESW-TS is published on npm registry successfully with the expected version.
  2. Update the version back with <****> in release.yml NPM publish step on branch-<major>.<minor>.x branch.
  3. Merge this release branch to master.