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

434 add configuration for automatic changelog generation #435

Merged
merged 4 commits into from
Dec 22, 2023

Conversation

ebma
Copy link
Member

@ebma ebma commented Oct 25, 2023

This template can be used to create a changelog. Its main purpose is to be used in Spacewalk's release flow to automatically generate a description for the new releases.

To generate the changelog you need to install git-chglog, see here and then run git-chglog -o CHANGELOG.md.

The CI job will run the generation with the latest tag as the argument so that the changelog is only generated containing the changes for the latest release. For example to generate the release notes for release v1.0.3, it will use git-chglog -o CHANGELOG.md v1.0.3...

Closes #434.

@ebma ebma linked an issue Oct 25, 2023 that may be closed by this pull request
@ebma ebma force-pushed the 434-add-configuration-for-automatic-changelog-generation branch from 4276cdc to 04f341f Compare December 21, 2023 17:11
@ebma ebma marked this pull request as ready for review December 21, 2023 17:11
@ebma ebma requested a review from a team December 21, 2023 17:19
@TorstenStueber
Copy link
Contributor

@ebma The description makes it sound like this will be run by CI. But how does it, it looks to me like you did not add this to any GitHub action.

commits:
commit_groups:
header:
pattern: "^(\\w*)[!]?\\:\\s(.*)$"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand why we use this commit header pattern here. (what even is the commit header?)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AFAIK the commit header is like the first line of your commit which can be 50 characters and the body would be the content you add in new lines.
But we don't need that anyways, so I removed it. Since we squash and merge every feature, it works fine to use the remaining config for merge commits.

@ebma
Copy link
Member Author

ebma commented Dec 22, 2023

My description might have been a little confusing but the CI I'm talking about is run on Gitlab pipelines. That's why I didn't add any changes here. This PR is about adding the necessary configuration so that the CI pipeline can run the commands I put into the description to generate meaningful changelogs.
Changing the Gitlab pipeline is not part of this ticket and something we need to do afterwards.

Copy link
Contributor

@TorstenStueber TorstenStueber left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great addition, looks good.

@ebma
Copy link
Member Author

ebma commented Dec 22, 2023

Merging this although the CI failed because the changes of this PR are unrelated to any relevant code and we already know that this is required to fix the CI.

@ebma ebma merged commit 23b9097 into main Dec 22, 2023
0 of 2 checks passed
@ebma ebma deleted the 434-add-configuration-for-automatic-changelog-generation branch December 22, 2023 11:26
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.

Add configuration for automatic changelog generation
2 participants