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

Check for invalid filenames in changes.d/ #619

Open
MetRonnie opened this issue Jun 28, 2024 · 1 comment
Open

Check for invalid filenames in changes.d/ #619

MetRonnie opened this issue Jun 28, 2024 · 1 comment

Comments

@MetRonnie
Copy link

Although towncrier create enforces valid fragment file names, creating a fragment file manually can sometimes lead to mistakes in the file name. It would be useful to include in our CI a check that all files in changes.d/ have valid fragment file names (excluding changelog-template.jinja of course).

Note we don't use towncrier check as we don't create fragments for small or non-user-facing changes.

@adiroiban
Copy link
Member

Hi Ronnie.

Thanks for the report.

I am not sure what is requested here.

Just asking :)

Can you please define what is considered a "valid fragment file name" ?

How else, other that via towncrier check are you expecting to have this implemented ?

Note we don't use towncrier check as we don't create fragments for small or non-user-facing changes.

You can create .misc or .ignore or '.hidden' fragments for small or non user facing changes.
In this way, you explicitly acknowledge that this branch doesn't need public release notes.


I would say that you should start using towncrier check.
It can help detect some errors in fragment file names.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants