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

feat: vale ignore towncrier directory #478

Merged
merged 8 commits into from
May 6, 2024
Merged

Conversation

klmcadams
Copy link
Contributor

Gives the option to ignore md files in the towncrier fragment file directory (typically doc/changelog.d). @da1910 ran into this issue where vale flagged codecov in the fragment file as an error. By default, the action will check the towncrier directory unless ignore-changelogd is specified.

If it makes more sense to ignore the changelog.d directory by default, then we can make the default value true. Let me know what you all think.

changelog.d directory not ignored: https://github.com/ansys/openapi-common/actions/runs/8930323884/job/24530231218?pr=575

changelog.d directory ignored & other rst files in doc are not ignored: https://github.com/ansys/openapi-common/actions/runs/8930356819/job/24530286024?pr=575

Closes #477

@klmcadams klmcadams requested a review from a team as a code owner May 2, 2024 21:07
@ansys-reviewer-bot
Copy link
Contributor

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

@klmcadams klmcadams requested a review from da1910 May 2, 2024 21:07
@github-actions github-actions bot added the maintenance Generic maintenance related label May 2, 2024
Copy link
Contributor

@SMoraisAnsys SMoraisAnsys left a comment

Choose a reason for hiding this comment

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

I would go for ignoring by default. I assume that many people will end up facing this issue at some point and have to ignore the changelogd directory anyway.

Copy link

@da1910 da1910 left a comment

Choose a reason for hiding this comment

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

Fix looks OK to me, I have no strong feelings about default/not, but the implementation looks reasonable (given my comments before about storing python in workflows)

@MaxJPRey
Copy link
Contributor

MaxJPRey commented May 3, 2024

I would go for ignoring by default. I assume that many people will end up facing this issue at some point and have to ignore the changelogd directory anyway.

I would also suggest to ignore it by default.

@klmcadams klmcadams merged commit 56313a9 into main May 6, 2024
16 checks passed
@klmcadams klmcadams deleted the maint/vale-ignore-changelogd branch May 6, 2024 18:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Generic maintenance related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Exclude the changelog fragments from the vale check by default
5 participants