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

Better commit/changelog validation when using Github #412

Open
daviddavis opened this issue Jun 18, 2021 · 1 comment
Open

Better commit/changelog validation when using Github #412

daviddavis opened this issue Jun 18, 2021 · 1 comment
Labels

Comments

@daviddavis
Copy link
Contributor

When using Github issues, towncrier is able to link changelog entries to the PR. So having an issue for each PR is less essential. We should allow the changelog to use the PR #. Check out this simple example from towncrier where 338 is the PR #.

Current validation

Today, the current validation is:

  • Check if the commit references any issues
    • If so, check that the issues are open and have changelog files in the CHANGES directory
  • Else, check if the commit has [noissue] in it
    • If not, fail the check

Proposal

I'd propose we modify the current behavior a bit:

  • Check if the commit references any issues
    • If so, check that the issues are open and have changelog files in the CHANGES directory
  • Else, check if the commit has [noissue] in it
    • If not, check that there's a changelog for the current PR #
      • If there's no changelog entry, fail the build

This would allow us to not have to specify [noissue] in cases where there's no issue but we still have a changelog entry which corresponds to the PR #.

@stale
Copy link

stale bot commented May 24, 2022

This issue has been marked 'stale' due to lack of recent activity. If there is no further activity, the issue will be closed in another 30 days. Thank you for your contribution!

@stale stale bot added the stale label May 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant