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

Jump to bottom

Add galaxy[no-changelog] check to galaxy rule #2832

Merged
merged 12 commits into from Jan 10, 2023
Merged

Add galaxy[no-changelog] check to galaxy rule #2832

merged 12 commits into from Jan 10, 2023

Conversation

alisonlhart
Copy link
Contributor

@alisonlhart alisonlhart commented Dec 15, 2022 •
edited

Adding a changelog check to the existing galaxy rule.

Checks for a changelog in the following locations:

  • <collection_root>/CHANGELOG.rst
  • <collection_root>/CHANGELOG.md
  • <collection_root>/changelogs/changelog.yml

If no changelog is found, then the following error is thrown:

galaxy[no-changelog]: "No changelog found. Please add a changelog file. Refer to the galaxy.md file for more info."

Rule information added to the galaxy.md file.

Resolves #2101

@alisonlhart alisonlhart marked this pull request as ready for review December 15, 2022 20:40
@alisonlhart alisonlhart requested review from a team as code owners December 15, 2022 20:40
ssbarnea
ssbarnea requested changes Dec 17, 2022
View reviewed changes
Copy link
Member

@ssbarnea ssbarnea left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The correct check is for changelog.yaml not changelog.yml. That is the only documented filename.

@alisonlhart
Copy link
Contributor Author

@ssbarnea Whoops, fixed!

@audgirka audgirka enabled auto-merge (squash) January 10, 2023 11:27
@audgirka audgirka merged commit 2f688cc into ansible:main Jan 10, 2023
@alisonlhart alisonlhart mentioned this pull request Jan 10, 2023
Merged
@ssbarnea ssbarnea changed the title Add no-changelog check to galaxy rule Add galaxy[no-changelog] check to galaxy rule Jan 11, 2023
@alisonlhart alisonlhart deleted the check_collection_changelog branch February 10, 2023 11:54
@cavcrosby cavcrosby mentioned this pull request May 15, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ssbarnea ssbarnea ssbarnea approved these changes

@audgirka audgirka Awaiting requested review from audgirka audgirka is a code owner automatically assigned from ansible/devtools

@priyamsahoo priyamsahoo Awaiting requested review from priyamsahoo priyamsahoo is a code owner automatically assigned from ansible/devtools

Assignees
No one assigned
Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

no-changelog: check_collection_changelog
3 participants
@alisonlhart @ssbarnea @audgirka