Skip to content

Commit 99a6274

Browse files
committed
docs: add release validation and announcement sections to release guide
Add two new sections to the release guide: - Release Validation: documents the current approach (e2e tests) and includes a validation checklist for before publishing - Announce the Release: documents the Slack announcement process for #topic-cf-gitops-runtime and #team-support-announcements
1 parent dd6e7bf commit 99a6274

File tree

1 file changed

+50
-6
lines changed

1 file changed

+50
-6
lines changed

docs/RELEASE_GUIDE.md

Lines changed: 50 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,13 @@ The instructions below explain how to do everything manually if you prefer that
1818
2. [Prerequisites](#prerequisites)
1919
3. [Release Types](#release-types)
2020
4. [Creating a New Minor Release](#creating-a-new-minor-release)
21-
5. [Publishing a Release](#publishing-a-release)
22-
6. [Creating a Patch Release](#creating-a-patch-release)
23-
7. [Cherry-Picking Fixes](#cherry-picking-fixes)
24-
8. [Writing Release Notes](#writing-release-notes)
25-
9. [Troubleshooting](#troubleshooting)
26-
10. [Reference](#reference)
21+
5. [Release Validation](#release-validation)
22+
6. [Publishing a Release](#publishing-a-release)
23+
7. [Creating a Patch Release](#creating-a-patch-release)
24+
8. [Cherry-Picking Fixes](#cherry-picking-fixes)
25+
9. [Writing Release Notes](#writing-release-notes)
26+
10. [Troubleshooting](#troubleshooting)
27+
11. [Reference](#reference)
2728
2829
---
2930
@@ -141,6 +142,27 @@ Or visit:
141142
142143
---
143144
145+
## Release Validation
146+
147+
After the prepare-release PR is automatically created and before publishing the release, the release should be validated to ensure stability.
148+
149+
### Current Approach
150+
151+
The CI pipeline runs e2e tests on every PR. If these tests pass, the release is considered validated and ready to publish.
152+
153+
> **Note**: Previously, releases were validated by deploying to staging environments and letting them run for a period before publishing. This approach is no longer in use. If additional validation is needed in the future, consider introducing a manual testing stage or dedicated validation environments.
154+
155+
### Validation Checklist
156+
157+
Before publishing, ensure:
158+
159+
- [ ] All CI checks pass (unit tests, linting, e2e tests)
160+
- [ ] The prepare-release PR has been reviewed
161+
- [ ] Release notes accurately reflect the changes
162+
- [ ] No known critical issues exist in the changes being released
163+
164+
---
165+
144166
## Publishing a Release
145167
146168
### Step 1: Check PR Status
@@ -186,6 +208,28 @@ Check the release:
186208
gh release view 0.27.0 --repo codefresh-io/gitops-runtime-helm
187209
```
188210
211+
### Step 5: Announce the Release
212+
213+
After the release is published, announce it to the team:
214+
215+
1. **Post in `#topic-cf-gitops-runtime`**:
216+
- Introduce the release with a brief summary of key changes
217+
- Include a link to the GitHub release notes
218+
219+
Example:
220+
```
221+
:rocket: GitOps Runtime v0.27.0 has been released!
222+
223+
Highlights:
224+
- [Key feature or fix 1]
225+
- [Key feature or fix 2]
226+
227+
Release notes: https://github.com/codefresh-io/gitops-runtime-helm/releases/tag/0.27.0
228+
```
229+
230+
2. **Cross-post to `#team-support-announcements`**:
231+
- Share the same announcement so the support team is aware of the new release
232+
189233
---
190234
191235
## Creating a Patch Release

0 commit comments

Comments
 (0)