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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

add doc_changes section #27

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f49d444
add doc_changes section
KB-perByte Apr 26, 2023
b125afe
Merge branch 'main' into doc_changes
cidrblock May 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions antsichaut/antsichaut.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -436,6 +436,15 @@ def main() -> None:
env_var="SKIP_CHANGELOG_LABELS",
required=False,
)
parser.add(
"--doc_changes_labels",
dest="doc_changes_labels",
type=str,
action="append",
help="the labels for doc_changes. Default: ['doc_changes']",
env_var="DOC_CHANGES_LABELS",
required=False,
)
parser.add("--version", action="version", version=version())

# Execute the parse_args() method
Expand All @@ -460,6 +469,8 @@ def main() -> None:
args.bugfixes_labels = ["bug", "bugfix"]
if not args.skip_changelog_labels:
args.skip_changelog_labels = ["skip_changelog"]
if not args.doc_changes_labels:
args.doc_changes_labels = ["doc_changes"]

repository = args.repository
since_version = args.since_version
Expand All @@ -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},
Copy link

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?

Copy link

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.

]
cl_cib = ChangelogCIBase(
Expand Down