Delegate release notes to external tool #3055
Conversation
Signed-off-by: Cornelius Weig <[email protected]>
corneliusweig
requested review from
balopat,
dgageot,
nkubala,
priyawadhwa and
tejal29
as code owners
hack/release.sh
Outdated
| release_notes_workdir="$(mktemp -d)" | ||
| trap 'rm -rf -- ${release_notes_workdir}' RETURN | ||
|
|
||
| # See https://stackoverflow.com/questions/56842385/using-go-get-to-download-binaries-without-adding-them-to-go-mod for this workaround |
There was a problem hiding this comment.
I would just add the tool to go mods!
There was a problem hiding this comment.
Can you explain a little how to do that? If I just add it with go get .../release-notes, then it will be lost on the next go mod tidy. Besides, I don't think this would install the tool in $GOPATH/bin or so.
There was a problem hiding this comment.
@corneliusweig One way to do it is to create a top level tools folder that is a sub-package, with it's own go.mod. In that folder, you add a tools.go file that imports xxx/release-notes. You can then run go mod vendor in that folder.
In the makefile, you'd run cd tools; go install -mod=vendor xxx/release-notes
There was a problem hiding this comment.
Here's a sample with golangci-lint: https://github.com/buildpack/pack/pull/299/files
There was a problem hiding this comment.
@dgageot oh.. that's a nice way. I tried to stay away from vendor mode though, it seems to work ok either way.
There was a problem hiding this comment.
Why did you avoid vendoring? The advantage is that there's nothing to download on the Travis. It's a bit quicker and more resilient.
There was a problem hiding this comment.
It was adding 11MB of vendored code. Besides, it is only run on developer machines, right? So will not affect Travis anyway.
I know that you are not a big fan of go modules, so if you have a strong opinion in this case, I won't argue any longer :)
There was a problem hiding this comment.
Not a big fan indeed. In that case, it's actually very convenient. You are right that it doesn't run on Travis so, yes, vendoring is not so useful. Good point!
corneliusweig
force-pushed
the
w/release-notes-helper
branch
from
c42e56b
to
5f59c6b
Compare
Description
This PR delegates the "heavy" lifting for creating the release changelog to an external tool hosted in my github space. I intend to maintain this tool and not break the formatting. @balopat also has write access to this repository and was involved in factoring out this piece of code.
The
hack/release_notes.shscript installs the external helper program ashack/release-notes, if not present.User facing changes
n/a
Next PRs.
n/a
Reviewer Notes