Skip to content

Commit 10c43c3

Browse files
authored
docs(ci): improve release note template (#5791)
* docs(ci): improve release note template * improve reference * Update scripts/releaser.sh
1 parent 7058c6a commit 10c43c3

File tree

2 files changed

+15
-4
lines changed

2 files changed

+15
-4
lines changed

docs/release.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@ You must be an official maintainer of the project to be able to do a release.
4141
- Run `scripts/releaser.sh` to create a new GitHub release. Alternatively you can create a release in the GitHub UI making sure to click on the autogenerate release node feature.
4242
- The step above will trigger the Kubernetes based CI/CD system [Prow](https://prow.k8s.io/?repo=kubernetes-sigs%2Fexternal-dns). Verify that a new image was built and uploaded to `gcr.io/k8s-staging-external-dns/external-dns`.
4343
- Create a PR in the [k8s.io repo](https://github.com/kubernetes/k8s.io) by taking the current staging image using the sha256 digest. They can be obtained with `scripts/get-sha256.sh`. Once the PR is merged, the image will be live with the corresponding tag specified in the PR.
44-
- See https://github.com/kubernetes/k8s.io/pull/540 for reference
44+
- See https://github.com/kubernetes/k8s.io/pull/8466 for reference
4545
- Verify that the image is pullable with the given tag
46-
- `docker run registry.k8s.io/external-dns/external-dns:v0.16.0 --version`
46+
- `docker run registry.k8s.io/external-dns/external-dns:v0.x.0 --version`
4747
- Branch out from the default branch and run `scripts/version-updater.sh` to update the image tag used in the kustomization.yaml and in documentation.
4848
- Create the PR with this version change.
4949
- Create an issue to release the corresponding Helm chart via the chart release process (below) assigned to a chart maintainer

scripts/releaser.sh

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,15 @@ function generate_changelog {
3030
echo "## :package: Others"
3131
echo
3232
cat "${MERGED_PRS}" | grep -v "\!" | grep -v feat[:\(] | grep -v fix[:\(] | grep -v docs[:\(]
33+
34+
echo
35+
echo "## :package: Docker Image"
36+
echo
37+
echo "\`\`\`sh"
38+
echo "# This pull command only works when it's released
39+
echo "docker pull registry.k8s.io/external-dns/external-dns:${VERSION}"
40+
echo "\`\`\`"
41+
3342
}
3443
3544
function create_release {
@@ -66,12 +75,14 @@ gh pr list \
6675
" | sort > "${MERGED_PRS}"
6776
6877
if [ $# -ne 1 ]; then
78+
export VERSION="v0.x.0"
6979
generate_changelog "${MERGED_PRS}"
7080
echo "** DRY RUN **"
7181
echo
72-
echo "To create a release: ./releaser.sh v0.17.0"
82+
echo "To create a release: ./releaser.sh v0.x.0"
7383
else
74-
generate_changelog "${MERGED_PRS}" | gh release create "$1" -t "$1" -p -F -
84+
export VERSION="$1"
85+
generate_changelog "${MERGED_PRS}" | gh release create "${VERSION}" -t "${VERSION}" -p -F -
7586
fi
7687
7788
rm -f "${MERGED_PRS}"

0 commit comments

Comments
 (0)