-
Notifications
You must be signed in to change notification settings - Fork 321
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Added support for go-changelog automations #1947
Conversation
0ccd45d
to
ba13e72
Compare
ba13e72
to
6f5043f
Compare
6f5043f
to
3fc44d5
Compare
Regardless of state, I won't merge this until 1.1 is released |
3fc44d5
to
a654c4c
Compare
a654c4c
to
a721950
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this looks great. we should undo the indexing change in markdown though
CONTRIBUTING.md
Outdated
@@ -17,13 +17,14 @@ | |||
1. [Updating consul-helm](#updating-consul-helm) | |||
1. [Testing a new CRD](#testing-a-new-crd) | |||
1. [Update Consul K8s acceptance tests](#update-consul-k8s-acceptance-tests) | |||
1. [Adding a new ACL Token](#adding-a-new-acl-token) | |||
1. [Testing the Helm chart](#testing-the-helm-chart) | |||
3. [Adding a new ACL Token](#adding-a-new-acl-token) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we should keep these as is. markdown does the right things with the indexing if you keep them all at "1"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💥
- added templates for go-changelog, pretty much copied from Consul - added a checker for missing changelog entries
- Prepare release now requires an additional LAST_RELEASE_GIT_TAG environment variable required by go-changelog - removed adding the unreleased tag to the Changelog as we will no longer be doing that. All changelog entries will be added at the time of release by the go-changelog tool
848fc44
to
f52927d
Compare
I'm merging this in without waiting for the tests to pass, nothing I've done touches production code |
* Added some go-changelog automations - added templates for go-changelog, pretty much copied from Consul - added a checker for missing changelog entries * added contributing doc information on new changelog * update prepare release to update the changelog - Prepare release now requires an additional LAST_RELEASE_GIT_TAG environment variable required by go-changelog - removed adding the unreleased tag to the Changelog as we will no longer be doing that. All changelog entries will be added at the time of release by the go-changelog tool
* Added some go-changelog automations - added templates for go-changelog, pretty much copied from Consul - added a checker for missing changelog entries * added contributing doc information on new changelog * update prepare release to update the changelog - Prepare release now requires an additional LAST_RELEASE_GIT_TAG environment variable required by go-changelog - removed adding the unreleased tag to the Changelog as we will no longer be doing that. All changelog entries will be added at the time of release by the go-changelog tool
I always add details to my commits and there isn't any crossover, so reviewing commit by commit is usually the best way to review my PRs
Changes proposed in this PR:
This PR adds go-changelog support to the Consul-K8s repo. This will be a new way of managing changelog items throughout the release cycle.
go-changelog
required templates and directoriespr/no-changelog
for ignoring missing changelogs if necessary otherwise a changelog is now requiredgo-changelog
toolprepare-release
to automatically rungo-changelog
and add the changes to theCHANGELOG.MD
fileHow I've tested this PR:
v1.0.4
and it generated a valid changelog:make prepare-release
and confirmed that it adds the changes with the correct version and date toCHANGELOG.MD
How I expect reviewers to test this PR:
👀
Checklist: