-
Notifications
You must be signed in to change notification settings - Fork 5
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
Conversation
Thanks for opening a Pull Request. If you want to perform a review write a comment saying: @ansys-reviewer-bot review |
There was a problem hiding this 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.
There was a problem hiding this 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)
I would also suggest to ignore it by default. |
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 unlessignore-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