automation - add changelog and release automation #86
Conversation
Add a new Github workflow for releases that automates the generation of a draft GH release with changelog notes. Pull requests will be required to add new file to at .changelog/<pr_number>.txt with a changelog message or label with skip-changelog to bypass the check. See CONTRIBUTING.md for more details. This backfills the .changelog directory with entries for changes since v0.14.0.
andrewkroh
added
the
skip-changelog
CONTRIBUTING.md
Outdated
| - Include a [changelog][changelog_docs] entry at `.changelog/{pr-number}.txt` with your pull request. | ||
| - Include tests that demonstrate the change is working. | ||
|
|
||
| [changelog_docs]: https://github.com/GoogleCloudPlatform/magic-modules/blob/2834761fec3acbf35cacbffe100530f82eada650/.ci/RELEASE_NOTES_GUIDE.md#expected-format |
There was a problem hiding this comment.
I don't see this line at all on the rendered github view: https://github.com/andrewkroh/stream/blob/release-workflow/CONTRIBUTING.md
But maybe there could be a template or examples of the format in this repo. I don't find the linked page very clear. Should there be a PR description before the release note? From the changelog in this PR, I guess not, but the doc makes it seem like it should.
There was a problem hiding this comment.
I have added more explanation and examples in the CONTRIBUTING.md. After a few changes are made there will be many examples to follow in the .changelog/ dir.
Describe the .changelog/*.txt file format.
andrewkroh
force-pushed
the
release-workflow
branch
from
cf6a953
to
d5205b5
Compare
andrewkroh
force-pushed
the
release-workflow
branch
from
d5205b5
to
b541db5
Compare
I could move it to something like |
|
That SGTM |
Add a new Github workflow for releases that automates the generation of a draft GH release with changelog notes.
Pull requests will be required to add new file to at
.changelog/<pr_number>.txtwith a changelog message or label withskip-changelogto bypass the check. See CONTRIBUTING.md for more details.This backfills the .changelog directory with entries for changes since v0.14.0.
(I cloned this from go-sysinfo.)