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)

Make sure the version is correct in package.json
- If not, bump it with a [No Jira] Prepare version vX.Y.Z-rcN commit message
Publish a new GitHub release targeting the candidate branch (usually the main branch):
- Title: @sonarsource/echoes-react - vX.Y.Z-rcN
- Description: You can leave this blank
- Check [x]Set as a pre-release
  - Make sure [ ]Set as the latest release has been automatically unchecked.
- Click Publish release

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
- Find the relevant release from the releases page and populate (as markdown) the notes section.
- 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
Bump the package version for the next development iteration with yarn version major|minor and commit with message [No Jira] Prepare for version x.y.

Check out the version branch branch-x.y
Bump the package version with yarn version patch and commit with message [No Jira] 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