-
Notifications
You must be signed in to change notification settings - Fork 9.6k
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
move changelog generation to changie #36260
Conversation
d8e277d
to
653e915
Compare
653e915
to
ef57bcb
Compare
ef57bcb
to
68f233c
Compare
68f233c
to
e986344
Compare
e986344
to
11af9a2
Compare
Is it worth changing the language in these comments now? |
79dda07
to
6285e48
Compare
Good point @xiehan, we don't need that comment at all anymore :) |
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.
I think we could update this to include the new changelog process as well? https://github.com/hashicorp/terraform/blob/main/.github/CONTRIBUTING.md#pull-request-lifecycle
We could also maybe add a little documentation in there around exactly what has to go into the changelog entries?
## Previous Releases | ||
|
||
For information on prior major and minor releases, refer to their changelogs: |
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.
should this be in the other file?
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.
Yeah, I mean technically yes, but I could not find a nice way to sed
a new line for the last minor version into the list of last versions so I chose to split it up in a way that I can just append to the top :D
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.
ah I see, that's what you meant in the description - I understand now 😅
@liamcervante yeah that does make sense, I added a line about the changelog entries 👍 |
This PR does the groundwork for moving our changelog generation from a manual process to changie.
After this change every PR can have one or multiple changelog entries added to them. We use these to compile the changelog for releases of all kinds. Every changelog entry can currently link to only one issue (if have multiple issues being resolved in one PR you need to add the links manually to your changelog content).
The script in this PR is intended to be used by maintainers when building out a new release and should facilitate most of the currently manual steps within this repo when doing releases.
I split up the experiments / previous releases content to easier insert a new line for the current release when creating everything for the next minor version.
sed
can be a bit annoying with the differences between osx and linux.Target Release
1.11.x
CHANGELOG entry