RELEASING.md

Releasing

Versioning

This project follows semver.

Major and minor versions follow the versioning in the Echoes Design System. Patches may diverge.

For more details, refer to the internal versioning strategy (Sonar employees only)

Release Process for Major and Minor Versions

• Create a new branch for the release and maintenance following the name convention branch-x.y

• Publish a new GitHub release targeting the release branch

  • Tag version: x.y.z-build_number
    • find it in the repox-main Github check, where it says Latest promoted build of '0.13.0-2686' from branch 'main'
  • Release title: @sonarsource/echoes-react - x.y.z
  • Find the relevant Jira release from the releases page and after ensuring the correct tickets are in there, release it, generating release not in Jira at the same time.
  • Populate the Github release notes section (copied as markdown from Jira).
    • Example: https://github.com/SonarSource/echoes-react/releases/tag/v0.5.0
  • click Publish Release

• Create a Jira release ticket in the REL project like this one

  • Summary: @sonarsource/echoes-react x.y
  • Documentation status: N/A
  • Short description: pull from version description
  • SQ compatibility: current version
  • Link to Jira RELEASE NOTES: copy from a previous release ticket, updating the release ID, e.g.: https://sonarsource.atlassian.net/projects/ECHOES/versions/15590/tab/release-report-all-issues?isReleaseNoteModalOpen=true

• Close the REL ticket you've created

• On master branch bump the package version for the next development iteration with yarn version major|minor and commit with message Prepare for version x.y.

Release Process for Patch Versions

• Check out the version branch branch-x.y

• Bump the package version with yarn version patch and commit with message Prepare for version x.y.z.

• Cherry-pick the commits from the main branch that need to be in this patch release

• Create a PR on the version branch with the changes

• Create a new version in the Echoes Design System project like this one

• Tag the relevant tickets with this new version

• Once the PR is merged, follow the same procedure as for Major/Minor versions, starting with the creation of a Jira REL ticket, and skipping the version bump at the end