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

Accept changlog.yml as a valid changelog #4218

Merged
merged 1 commit into from
Jun 14, 2024

Conversation

cavcrosby
Copy link
Contributor

Fixes #4105.

I'd like to mention that when looking over #2832 again, I see that changelog.yaml was preferred over changelog.yml because the latter wasn't documented. While this isn't true anymore, changelog.yml appears to be sparsely mentioned (only reference I found in the offical docs was here). This is to say, I wonder if this should be fixed.

@alisonlhart
Copy link
Contributor

alisonlhart commented Jun 11, 2024

I recall now that the reasoning for excluding .yml originally was out of an abundance of caution. antsibull-changelog generates a changelogs/changelog.yaml file specifically, and this is likely the reason a lot of the docs specifically mention .yaml.
Edit: The Ansible core team has confirmed that both extensions are accepted.

@ssbarnea ssbarnea merged commit c37e909 into ansible:main Jun 14, 2024
25 of 26 checks passed
@cavcrosby cavcrosby deleted the accept-changelog-yml branch June 15, 2024 13:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Archived in project
3 participants