Skip to content

Commit 27c3526

Browse files
authored
chore(releasing): update patch release template with extra step details
1 parent 752d424 commit 27c3526

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

.github/ISSUE_TEMPLATE/patch-release.md

+10-5
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Before the release:
1010
- [ ] Create a new release preparation branch from the current release branch
1111
- `git fetch && git checkout v0.<current minor version> && git checkout -b prepare-v0.<new version number>`
1212
- [ ] Cherry-pick in all commits to be released from the associated release milestone
13+
- If any merge conflicts occur, attempt to solve them and if needed enlist the aid of those familiar with the conflicting commits.
1314
- [ ] Run `cargo vdev build release-cue` to generate a new cue file for the release
1415
- [ ] Add `changelog` key to generated cue file
1516
- [ ] `git log --no-merges --cherry-pick --right-only <last release tag>...`
@@ -29,20 +30,24 @@ Before the release:
2930

3031
On the day of release:
3132

33+
- [ ] Ensure release date in cue matches current date.
3234
- [ ] Rebase the release preparation branch on the release branch
33-
- [ ] Ensure release date in cue matches current date.
34-
- [ ] Squash the release preparation commits (but not the cherry-picked commits!) to a single
35-
commit. This makes it easier to cherry-pick to master after the release. 
35+
- Squash the release preparation commits (but not the cherry-picked commits!) to a single
36+
commit. This makes it easier to cherry-pick to master after the release.
37+
- `git checkout prepare-v0.<new version number> && git rebase -i v0.<current minor version>`
3638
- [ ] Merge release preparation branch into the release branch
37-
- `git co v0.<current minor version> && git merge --ff-only prepare-v0.<current minor version>.<patch>`
39+
- `git co v0.<current minor version> && git merge --ff-only prepare-v0.<current minor version>.<patch>`
3840
- [ ] Tag new release
3941
- [ ] `git tag v0.<minor>.<patch> -a -m v0.<minor>.<patch>`
4042
- [ ] `git push origin v0.<minor>.<patch>`
4143
- [ ] Wait for release workflow to complete
4244
- Discoverable via [https://github.com/timberio/vector/actions/workflows/release.yml](https://github.com/timberio/vector/actions/workflows/release.yml)
45+
- [ ] Push the release branch to update the remote (This should close the preparation branch PR).
46+
- `git checkout v0.<current minor version> && git push`
4347
- [ ] Release updated Helm chart. See [releasing Helm chart](https://github.com/vectordotdev/helm-charts#releasing).
4448
- [ ] Once Helm chart is released, updated Vector manifests
45-
- Run `cargo vdev build manifests` and open a PR with changes
49+
- Run `cargo vdev build manifests` and open a PR with changes
4650
- [ ] Add docker images to [https://github.com/DataDog/images](https://github.com/DataDog/images/tree/master/vector) to have them available internally.
51+
- Follow the [instructions at the top of the mirror.yaml file](https://github.com/DataDog/images/blob/fbf12868e90d52e513ebca0389610dea8a3c7e1a/mirror.yaml#L33-L49).
4752
- [ ] Cherry-pick any release commits from the release branch that are not on `master`, to `master`
4853
- [ ] Kick-off post-mortems for any regressions resolved by the release

0 commit comments

Comments
 (0)