Skip to content

Commit 8fa65cf

Browse files
BUILD-9115 document release process
1 parent b93b289 commit 8fa65cf

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -997,3 +997,37 @@ After running this action, the following environment variables are available:
997997
- **Unified Caching Strategy**: Single cache key for both smctl and jsign tools to optimize cache efficiency
998998
- **Smart Cache Management**: Caches smctl installation directory and jsign .deb package for faster subsequent runs
999999
- **Automatic Setup**: Handles all DigiCert authentication and environment configuration
1000+
1001+
## Release
1002+
1003+
1. Create a new GitHub release on <https://github.com/SonarSource/ci-github-actions/releases>
1004+
1005+
Increase the **patch** number for **fixes**, the **minor** number for **new features**, and the **major** number for **breaking changes**.
1006+
1007+
Edit the generated release notes to curate the highlights and key fixes, add notes, provide samples of new usage if applicable...
1008+
1009+
Make sure to include any **breaking changes** in the notes.
1010+
1011+
2. After release, the `v*` branch must be updated for pointing to the new tag.
1012+
1013+
```shell
1014+
git fetch --tags
1015+
git update-ref -m "reset: update branch v1 to tag 1.y.z" refs/heads/v1 1.y.z
1016+
git push origin v1
1017+
```
1018+
1019+
3. Communicate the new release on the Slack [#ask-github-migration](https://sonarsource.enterprise.slack.com/archives/C09791CRUKF) channel.
1020+
> 🚀 **New release `1.y.z` of `ci-github-actions` is live!** 🚀
1021+
>
1022+
> The v1 branch has been updated, so workflows using `@v1` will automatically receive these improvements.
1023+
>
1024+
> ### ✨ What's New
1025+
>
1026+
> - _Curated highlights from release notes_
1027+
>
1028+
> ### 🐛 Key Fixes
1029+
>
1030+
> - _Curated highlights from release notes_
1031+
>
1032+
> For all the details, you can
1033+
> [read the full release notes on GitHub](https://github.com/SonarSource/ci-github-actions/releases/tag/1.y.z).

0 commit comments

Comments
 (0)