Introduce release notes #80
Conversation
RELEASE.md
Outdated
| ```bash | ||
| CGO_ENABLED=0 make sha512sum | ||
|
|
||
| # or using docker | ||
| docker run --rm -v "$GOPATH":/go -w /go/src/github.com/DataDog/pupernetes golang:1.10 make sha512sum | ||
| ``` | ||
| > note: you need go 1.10 |
There was a problem hiding this comment.
Move this comment prior the local build (go 1.10 is not needed if they have Docker).
RELEASE.md
Outdated
| ``` | ||
| > note: v0.3.0 is a example and need to be adapted | ||
|
|
||
| Compile statically the binary and generate the sha512sum. | ||
| ```bash | ||
| CGO_ENABLED=0 make sha512sum |
There was a problem hiding this comment.
We should get rid of all CGO_ENABLED=0 since this is the default value in the makefile.
There was a problem hiding this comment.
That depend, if the user still have some setup with that set already up it's not ideal.
RELEASE.md
Outdated
| ```bash | ||
| cp -v kube-csr.sha512sum pr-kube-csr.sha512sum | ||
| make clean | ||
| CGO_ENABLED=0 make sha512sum |
There was a problem hiding this comment.
Remove CGO_ENABLED=0.
RELEASE.md
Outdated
| ### Push tags | ||
| Tag the release with the new version (e.g. v0.3.0): | ||
| ```bash | ||
| git tag v0.3.0 |
There was a problem hiding this comment.
Do we encourage tagging locally? IMHO it's less error prone to do that from GitHub's UI.
There was a problem hiding this comment.
You're right 👍
RELEASE.md
Outdated
| 0.3.0 -> 0.4.0 | ||
| 0.9.0 -> 0.10.0 | ||
| Updates: | ||
| - [releasenotes](./releasenotes.md) accordingly. |
There was a problem hiding this comment.
Is there any kind of script to generate this list from issue's tags?
There was a problem hiding this comment.
Not yet but it's a good point.
RELEASE.md
Outdated
| ```text | ||
| # Patch update | ||
| 0.3.0 -> 0.3.1 | ||
| Create a PR named as example: `release-v0.3.0` |
What does this PR do?
Introduce the release note.
Motivation
Improve the release process to validate the release notes.
Additional Notes
I have to update all releases to stay coherent.