Skip to content
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

Merged
merged 7 commits into from
Jan 7, 2025
Merged

Conversation

DanielMSchmidt
Copy link
Contributor

@DanielMSchmidt DanielMSchmidt commented Jan 3, 2025

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

  • This change is user-facing and I added a changelog entry.
  • This change is not user-facing.

@xiehan
Copy link
Member

xiehan commented Jan 7, 2025

Is it worth changing the language in these comments now?

@DanielMSchmidt
Copy link
Contributor Author

Good point @xiehan, we don't need that comment at all anymore :)

Copy link
Member

@liamcervante liamcervante left a 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?

Comment on lines +9 to +11
## Previous Releases

For information on prior major and minor releases, refer to their changelogs:
Copy link
Member

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?

Copy link
Contributor Author

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

Copy link
Member

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 😅

@DanielMSchmidt
Copy link
Contributor Author

@liamcervante yeah that does make sense, I added a line about the changelog entries 👍

liamcervante
liamcervante previously approved these changes Jan 7, 2025
.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
Co-authored-by: Liam Cervante <liam.cervante@hashicorp.com>
@DanielMSchmidt DanielMSchmidt merged commit fda4387 into main Jan 7, 2025
10 of 11 checks passed
@DanielMSchmidt DanielMSchmidt deleted the changelog-generation branch January 7, 2025 11:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants