Skip to content

Commit 3cc4cc6

Browse files
authored
Merge pull request #284 from almaslennikov/update-release-template
Update new release template
2 parents c917986 + bc33b55 commit 3cc4cc6

File tree

2 files changed

+19
-16
lines changed

2 files changed

+19
-16
lines changed

.github/ISSUE_TEMPLATE/new-release.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,40 +12,44 @@ Please do not remove items from the checklist
1212
- [ ] Network-operator related component versions in Helm chart are up to date. (otherwise, submit PR to update)
1313
- [ ] node-feature-discovery
1414
- [ ] SR-IOV Network Operator
15+
- [ ] Verify that new versions of operator, configdaemon and webhooks components are compatible
16+
- [ ] Use latest releases of sriovcni and ibsriovcni
1517
- [ ] Manifest related component default versions
1618
- [ ] Example folder is up to date (otherwise submit PR to update)
1719
- [ ] Update network-operator Helm `Chart.yaml` with the release version (`appVersion`, `version` fields)
1820
```
1921
> ./scripts/releases/prepare-release.sh v0.1.2 "Jane Doe <[email protected]>"
2022
```
2123
- [ ] Ensure Helm CI is passing on updated Chart.
22-
- [ ] Tag release
2324
- [ ] Create a new github release
2425
- [ ] Release title: vx.y.z, Release description: Changelog from this issue
2526
- [ ] Release artifacts for current release
26-
- [ ] Update gh-pages branch
27+
- [ ] Update gh-pages branch using the script
2728
```
28-
> ./scripts/releases/update-gh-pages.sh network-operator-0.1.2.tgz
29+
> ./scripts/releases/update-gh-pages.sh -p <remote_fork> network-operator-0.1.2.tgz
2930
```
30-
- [ ] Create Helm package (master branch on release tag commit):
31-
```
31+
Or do it manually:
32+
- [ ] Create Helm package (master branch on release tag commit):
33+
```
3234
> helm package deployment/network-operator
33-
```
34-
- [ ] Place Helm package under gh-pages branch in `release` dir
35-
- [ ] Update `index.yaml` file under gh-pages branch in `release` dir:
36-
```
35+
```
36+
- [ ] Place Helm package under gh-pages branch in `release` dir
37+
- [ ] Update `index.yaml` file under gh-pages branch in `release` dir:
38+
```
3739
> # assuming we are under release dir
3840
> mkdir tmpdir; cp <helm-package.tgz> ./tmpdir
3941
> helm repo index ./tmpdir --url https://mellanox.github.io/network-operator/release --merge ./index.yaml
4042
> mv -f ./tmpdir/index.yaml ./; rm -rf ./tmpdir
41-
```
42-
- [ ] Update gh-pages branch README.md with `deployment/README.md` from master branch (on release tag commit)
43-
- [ ] Submit PR against `gh-pages` branch:
44-
```
43+
```
44+
- [ ] Push to remote:
45+
```
4546
> git add <helm .tgz package> <release/index.yaml> <README.md>
4647
> git commit -s -m "Release Network-Operator vx.y.z"
4748
> git push ...
48-
```
49+
```
50+
After that:
51+
- [ ] Update gh-pages branch README.md with `deployment/README.md` from master branch (on release tag commit)
52+
- [ ] Submit PR against `gh-pages` branch
4953
- [ ] Add a link to the release in this issue
5054
- [ ] Verify new image is published to the registry
5155
- [ ] Close this issue

scripts/releases/update-gh-pages.sh

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,5 @@ git commit -S -m "$commit_msg"
8181

8282
if [ -n "$push_remote" ]; then
8383
echo "Pushing gh-pages to $push_remote"
84-
git push "$push_remote" gh-pages
85-
84+
git push "$push_remote" HEAD:gh-pages
8685
fi

0 commit comments

Comments
 (0)