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

Changelog fragments #6

Open
gardar opened this issue Feb 21, 2023 · 6 comments
Open

Changelog fragments #6

gardar opened this issue Feb 21, 2023 · 6 comments
Labels
help wanted Extra attention is needed

Comments

@gardar
Copy link
Contributor

gardar commented Feb 21, 2023

I feel that most of the projects that use antsibull-changelog are using it with changelog fragments. It would be useful if antsichaut would support writing changelog fragments and I think it could help with adoption.

@rndmh3ro rndmh3ro added the help wanted Extra attention is needed label Feb 21, 2023
@rndmh3ro
Copy link
Collaborator

Hm, that would mean that there are people or projects, that use manually written changelog fragments and antsichaut-automation? Or are the changelog fragments created automatically somewhere?

@gardar
Copy link
Contributor Author

gardar commented Feb 21, 2023

I looked at quite a few CI workflows when I came across antsichaut. A common CI job for antsibull-changelog seems to be where it's confirmed that the PR contains a fragment file and then antsibull-changelog is used to generate the changelog from it. The fragments themselves always seem to be done manually and antsichaut is the only tool I've seen that's generating the changelogs automatically.

@rndmh3ro
Copy link
Collaborator

Yes, that's the whole reason antsichaut exists. i didn't want to manually create fragments for every PR (or tell the contributors to do so).

So I'm still not sure how the changelog-fragments should be supported b< antsichaut.

@gardar
Copy link
Contributor Author

gardar commented Feb 23, 2023

Well basically it would just write to a new fragment file for each opened PR instead of appending to the changelogs.yaml file.

@rndmh3ro
Copy link
Collaborator

I'm still not sure what the benefit of this would be, however I'd be fine with someone implementing it.

@gardar
Copy link
Contributor Author

gardar commented Feb 23, 2023

It's mostly just different styles, if you've already got a project with fragments you might want to keep using fragments but fill them out automatically with antsichaut.
And fragments is actually what the ansible core project uses: https://docs.ansible.com/ansible/latest/community/development_process.html#creating-changelog-fragments

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants