Skip to content

Conversation

KB-perByte
Copy link

@KB-perByte KB-perByte commented Apr 26, 2023

extend support for doc_changes

{"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},

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).

Copy link
Author

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.

Copy link
Author

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?

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.

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