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

Use Semantic Versioning to generate CHANGELOG.md #75

Closed
macinsight opened this issue Nov 27, 2023 · 6 comments
Closed

Use Semantic Versioning to generate CHANGELOG.md #75

macinsight opened this issue Nov 27, 2023 · 6 comments
Assignees
Labels
repo-feature Feature concerning the repository as a whole

Comments

@macinsight
Copy link
Collaborator

Instead of manually updating the changelog.md, it could be a good idea to use the GItHub Releases' "Generate Release Notes" feature. This automatically adds Release notes, including merged PRs, contributors et cetera.

@macinsight macinsight added the repo-feature Feature concerning the repository as a whole label Nov 27, 2023
@macinsight
Copy link
Collaborator Author

We could also forego the Releases feature (As that might just not fit the usecase, remains to be seen), and instead implement another workflow, e.g the Release Changelog Builder, which also supports differing branches.

@macinsight
Copy link
Collaborator Author

Or, if we implement semantic versioning from #74 (as it’s currently configured in that PR), we could use this action to generate the changelog.md

@macinsight macinsight changed the title Enable GitHub Releases to generate changelogs with merging of PRs Use Semantic Versioning to generate CHANGELOG.md Nov 27, 2023
@macinsight
Copy link
Collaborator Author

Update: I'm testing the workflow on the branch "ci" to see if it even works the way I want it to. So far, so... meh.

@macinsight
Copy link
Collaborator Author

Yay, it works!
@coavins If you want, you can merge. I keep forgetting which models I added, the auto-generated CL helps tremendously with that.

@macinsight
Copy link
Collaborator Author

macinsight commented Nov 28, 2023

Update: Fails to work after working the first time, see #93

@coavins You might have to create a repository secret, e.g CHANGELOG_BUILD_TOKEN with specific permission for the token give the github.token, AKA GITHUB_TOKEN, which is autogenerated each time a workflow kicks off, the permissions contents: write so that it can commit and pull-request: write so that the changelog can be committed and doesn’t fail while telling me it didn’t.

@macinsight
Copy link
Collaborator Author

Workflow is failing, will be revisited and tested in another repository so I can rule out issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
repo-feature Feature concerning the repository as a whole
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants