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

Please document what towncrier.check check for and how to use it #154

Closed
htgoebel opened this issue Jul 9, 2019 · 2 comments · Fixed by #337
Closed

Please document what towncrier.check check for and how to use it #154

htgoebel opened this issue Jul 9, 2019 · 2 comments · Fixed by #337
Labels

Comments

@htgoebel
Copy link

htgoebel commented Jul 9, 2019

The README does not state anything about towncrier.check. NEWS.rst says:

Features:

  • python -m towncrier.check, which will check a Git branch for the presence of added newsfiles […]

Please add a few lines of documentation:
What exactly does towncrier.check check for? What is its intended usage?

@tjanez tjanez mentioned this issue Jan 8, 2020
@altendky altendky added the docs label Nov 26, 2020
@achimnol
Copy link

achimnol commented Jan 18, 2021

I just found that towncrier.check only checks the existence of news fragments, not their numberings with the current PR number or other IDs. It would be nice to have a configuration to specify the environment variable name and/or pattern to extract and compare the IDs from the file names of fragments with the ID from the CI environment or an optional cli argument.

@altendky
Copy link
Member

@achimnol, thanks for the suggestion. That sounds like a feature request deserving of its own issue in addition to the mention here? It sort of plays into the discussion in #309 as well, so reference that, but at the moment I think a dedicated ticket would be good.

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

Successfully merging a pull request may close this issue.

3 participants