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

ci: Reject PRs without CHANGELOG update #584

Merged
merged 5 commits into from
May 28, 2021
Merged

Conversation

Ana06
Copy link
Member

@Ana06 Ana06 commented May 27, 2021

This PR includes a proposal to improve the pull request template and a GitHub Action to reject pull requests which don't update the CHANGELOG. The Action dismiss the request once the CHANGELOG has been updated or No CHANGELOG update needed has been marked in the PR description.

Closes #457

You can see it working here: Ana06#36

Note I needed to fork and release my own versions of get-changed-files and automatic-pull-request-review. I tried to submited my code upstream, but I didn't get an answer. In case you want to review that code:

Checklist

  • No CHANGELOG update needed
  • No new tests needed
  • No documentation update needed

Ana06 added a commit to Ana06/capa that referenced this pull request May 27, 2021
Ana06 added a commit to Ana06/capa that referenced this pull request May 27, 2021
Copy link
Collaborator

@mr-tz mr-tz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great, thanks a lot!


### Tests
### Checklist
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's more an "Unchecklist" 😉

.github/workflows/changelog.yml Outdated Show resolved Hide resolved
@Ana06
Copy link
Member Author

Ana06 commented May 28, 2021

It seems there are now plans to release jitterbit/get-changed-files with the change we need: jitterbit/get-changed-files#27 (comment) Should we wait for the release or just use my fork? It looks like the release will include very similar changes to the ones I have released. We don't need to block the PR because of that, as we can always update it later.

@mr-tz
Copy link
Collaborator

mr-tz commented May 28, 2021

Up to you. Feel free to merge and maybe create an issue to update once it's available. Thanks for all the Actions R&D!

Ana06 added 5 commits May 28, 2021 11:08
After using the PR template for a while, I think simplifying it will be
helpful:

- GitHub includes the commit message description automatically with the
aim of saving you time as it is sometimes also a good PR description.
With the current template, I need to cut this test and paste it into the
description section (which is really annoying!).

- Make a single simpler checklist. Add information as comment and have a
straightforward list which helps us remembering the changelog, tests and
documentation without needing to invest much time. The changelog
bulletpoint will also be used in GitHub Actions.
Request changes in a PR without CHANGELOG update.
`Ana06/[email protected]` is a fork of
https://github.com/AndrewMusgrave/automatic-pull-request-review which
fixes `DISMISS` and provides an `allow_duplicate` option which allows to
only approve once.
Ana06/[email protected] is a fork of
https://github.com/jitterbit/get-changed-files, which supports
`pull_request_target` and allow to filter files using regular
expressions.

As we need to use `pull_request_target`, Ana06/[email protected]
works, but jitterbit/get-changed-files@v1 doesn't.
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

Successfully merging this pull request may close these issues.

Improve release process: Update CHANGELOG in every PR
3 participants