Skip to content

Commit 025a74d

Browse files
BUILD-10483 update release instructions
1 parent 829a4d8 commit 025a74d

1 file changed

Lines changed: 48 additions & 33 deletions

File tree

README.md

Lines changed: 48 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1496,12 +1496,21 @@ Example with a build action (same idea applies to other actions):
14961496

14971497
## Release
14981498

1499+
Before making a release, ensure that all the dummy dogfooding actions succeed and that their badges are green.
1500+
See the [Dogfooding Status](#dogfooding-status) at the top of this README.
1501+
1502+
Follow semantic versioning principles when determining the new version number based on the nature of the changes (**new features**,
1503+
improvements, fixes, documentation, and **breaking changes**).
1504+
14991505
1. Create a new GitHub release on <https://github.com/SonarSource/ci-github-actions/releases>
15001506

1501-
Increase the **patch** number for **fixes**, the **minor** number for **new features**, and the **major** number for
1502-
**breaking changes**.
1507+
Semantic versioning is crucial for clear communication of the changes in each release:
15031508

1504-
Edit the generated release notes to curate the highlights and key fixes. Make sure that the notes are clear and informative.
1509+
- Increase the **patch** number for **bug fixes**, **improvements**, and **documentation updates**,
1510+
- Increase the **minor** number for **new features**,
1511+
- Increase the **major** number for **breaking changes**.
1512+
1513+
Edit the generated release notes to curate the highlights and key fixes. Make sure that the notes are clear and informative.
15051514

15061515
```markdown
15071516
## What's Changed
@@ -1520,14 +1529,14 @@ Example with a build action (same idea applies to other actions):
15201529
## New Contributors
15211530
* ...
15221531
1523-
---
1532+
---
15241533
1525-
Additional notes, examples, or references if applicable.
1534+
Additional notes, examples, or references if applicable.
15261535
15271536
**Full Changelog**: https://github.com/SonarSource/ci-github-actions/compare/...
1528-
```
1537+
```
15291538

1530-
Make sure to include any **breaking changes** in the notes.
1539+
Make sure to include any **breaking changes** in the notes.
15311540

15321541
2. After release, the `v*` branch must be updated for pointing to the new tag.
15331542

@@ -1537,29 +1546,35 @@ Example with a build action (same idea applies to other actions):
15371546
git push origin v1
15381547
```
15391548

1540-
3. Communicate the new release on the Slack [#ask-github-migration](https://sonarsource.enterprise.slack.com/archives/C09791CRUKF) channel.
1541-
> 🚀 **New release `1.y.z` of `ci-github-actions` is live!** 🚀
1542-
>
1543-
> The v1 branch has been updated, so workflows using `@v1` will automatically receive these improvements.
1544-
>
1545-
> ---
1546-
>
1547-
> ### ✨ What's New
1548-
>
1549-
> - _Curated highlights from release notes: new features, important new options_
1550-
>
1551-
> ### 🚀 Improvements
1552-
>
1553-
> - _Curated highlights from release notes: improvement and upgrades_
1554-
>
1555-
> ### 🐛 Bug Fixes
1556-
>
1557-
> - _Curated highlights from release notes_
1558-
>
1559-
> ### 📚 Documentation
1560-
>
1561-
> - _Curated highlights from release notes_
1562-
>
1563-
>
1564-
> For all the details, you can
1565-
> [read the full release notes on GitHub](https://github.com/SonarSource/ci-github-actions/releases/tag/1.y.z).
1549+
3. Communicate Updates, Changes and Migrations
1550+
1551+
Communicate the new release on the [#ops-platform-releases](https://sonarsource.enterprise.slack.com/archives/C0A6RL3L9BP) Slack
1552+
channel.
1553+
1554+
> 🚀 **New release `1.y.z` of `ci-github-actions`** (`v1` branch updated) 🚀
1555+
>
1556+
> ---
1557+
>
1558+
> ### ✨ What's New
1559+
>
1560+
> - _Curated highlights from release notes: new features, important new options_
1561+
>
1562+
> ### ⚡ Improvements
1563+
>
1564+
> - _Curated highlights from release notes: improvement and upgrades_
1565+
>
1566+
> ### 🐛 Bug Fixes
1567+
>
1568+
> - _Curated highlights from release notes_
1569+
>
1570+
> ### 📚 Documentation
1571+
>
1572+
> - _Curated highlights from release notes_
1573+
>
1574+
>
1575+
> For all the details, you can
1576+
> [read the full release notes on GitHub](https://github.com/SonarSource/ci-github-actions/releases/tag/1.y.z).
1577+
1578+
Communicate major updates, changes and migrations that require action from users following as indicated in
1579+
the [Updates, Changes and Migrations for Squads - Platform](https://xtranet-sonarsource.atlassian.net/wiki/spaces/Platform/pages/4385374219/Updates+Changes+and+Migrations+for+Squads+-+Platform#Usage-of-Communication-Channels)
1580+
xtranet page.

0 commit comments

Comments
 (0)