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

tox4: suggested towncrier file "something.trivial" is not permitted by pre-commit check #2007

Closed
jugmac00 opened this issue Apr 8, 2021 · 4 comments

Comments

@jugmac00
Copy link
Member

jugmac00 commented Apr 8, 2021

I tried to use a towncrier file as suggested in the docs a la "something.trivial" but this was not permitted by pre-commit :-D

changelog filenames......................................................Failed
- hook id: changelogs-rst
- exit code: 1

changelog files must be named ####.(feature|bugfix|doc|removal|misc).rst

docs/changelog/minor.doc.improvements.trival

Originally posted by @jugmac00 in #2006 (comment)

@gaborbernat
Copy link
Member

We need to update the documentation to follow that pre-commit rule.

@jugmac00
Copy link
Member Author

jugmac00 commented Apr 8, 2021

So, do we want a failing CI when somebody creates a typofix PR? Or rather update the pre-commit rule to allow something.trivial files again?

@gaborbernat
Copy link
Member

typofix PRs are misc if outside of documentation 👍🏻 and within just doc

jugmac00 added a commit that referenced this issue Apr 9, 2021
This fixes #2007

Part of the #2007 was already fixed by #2006, ie the paragraph about how
to create pseudo towncrier snippets was removed.
gaborbernat pushed a commit that referenced this issue Apr 9, 2021
This fixes #2007

Part of the #2007 was already fixed by #2006, ie the paragraph about how
to create pseudo towncrier snippets was removed.
@jugmac00
Copy link
Member Author

jugmac00 commented Apr 9, 2021

Hm, I wonder why this was not autoclosed by #2010... any way, it's done.

@jugmac00 jugmac00 closed this as completed Apr 9, 2021
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