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.

Sign up for GitHub

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

Jump to bottom

Add a CI job to ensure that CHANGELOG is updating in a PR #33

Open
John15321 opened this issue Aug 15, 2022 · 1 comment
Open

Add a CI job to ensure that CHANGELOG is updating in a PR #33

John15321 opened this issue Aug 15, 2022 · 1 comment
Labels
blocked CI/CD documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Milestone
🚀 CI/CD

Comments

@John15321
Copy link
Contributor

Add a Ci job that would check that the CHANGELOG file has gotten updated with a given Pull Request.
A simple git diff between the feature branch and the target branch will be enough.

Blocked by:
@John15321 John15321 added documentation Improvements or additions to documentation CI/CD blocked labels Aug 15, 2022
@John15321 John15321 moved this to Todo in rust-pip Aug 15, 2022
@John15321 John15321 added help wanted Extra attention is needed good first issue Good for newcomers labels Aug 15, 2022
@John15321 John15321 mentioned this issue Aug 15, 2022
Open
@John15321 John15321 changed the title Add a CI job to ensure that CHANGELOG is updating in a PR Add a CI job to ensure that CHANGELOG is updating in a PR Aug 15, 2022
@dawnofmidnight
Copy link

Personally, I think this is kind of a pain. There are tons of PRs that really don't need a changelog entry. Even if you relied on a maintainer adding some sort of a "skip news" label, that takes a while and causes CI to fail for little reason.

I think that it's enough to add it to the PR template and reviewers can check if the PR needs it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
blocked CI/CD documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
🚀 CI/CD
Development

No branches or pull requests
2 participants
@John15321 @dawnofmidnight