-
Notifications
You must be signed in to change notification settings - Fork 4
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
add doc_changes section #27
base: main
Are you sure you want to change the base?
Conversation
@@ -474,6 +485,7 @@ def main() -> None: | |||
{"title": "removed_features", "labels": args.removed_features_labels}, | |||
{"title": "security_fixes", "labels": args.security_fixes_labels}, | |||
{"title": "bugfixes", "labels": args.bugfixes_labels}, | |||
{"title": "doc_changes", "labels": args.doc_changes_labels}, | |||
{"title": "skip_changelog", "labels": args.skip_changelog_labels}, |
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.
Is this adding a docs_changes
section to the changelogs/changelog.yaml
file? This would be problematic since changelogs/config.yaml
likely doesn't know about it, and such a section name also isn't standardized (see the specs https://github.com/ansible-community/antsibull-changelog/blob/main/docs/changelog.yaml-format.md).
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.
@felixfontein this has been added considering ansible network collections, ref
which considers doc_changes as a valid changelog attribute.
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 a PR be added in core for this to be a valid part of the schema?
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.
This is unrelated to core, it's rather a community issue. It should probably be brought up in the docs working group (DaWGs).
Also since most collections do not support this (with an explicit config file that does not cover this section), this should probably be something that's configurable per collection for antsichaut (probably a good idea anyway to make the labels configurable), or antsichaut should use the antsibull-changelog config.
extend support for doc_changes