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

Improve release process: Update CHANGELOG in every PR #457

Closed
Ana06 opened this issue Mar 9, 2021 · 3 comments · Fixed by #584
Closed

Improve release process: Update CHANGELOG in every PR #457

Ana06 opened this issue Mar 9, 2021 · 3 comments · Fixed by #584
Assignees
Labels
CI Continuous Integration configuration enhancement New feature or request question Further information is requested

Comments

@Ana06
Copy link
Member

Ana06 commented Mar 9, 2021

Instead of having to go over all commits when we release, I suggest we update the CHANGELOG in every PR. Two things are needed to put this in practice:

  1. CHANGELOG template.
  2. GitHub Action to enforce this is used. A check in PR will fail if the CHANGELOG is not modified and the no changelog (or similar name) tag is not used.
  3. Update documentation
  4. [OPTIONAL] Create a PR template (as with issues to remind about this and link the documentation)

My only concern about this approach are the merge conflicts in the CHANGELOG file. But we could try it and adapt the process if it doesn't work.

Advantages:

  • capa users can see what changes they might expect in upcoming releases
  • The author of a change is the person who know the change the best and consequently the one who can write the best CHANGELOG entry
  • Make releasing easier and less time consuming, as just some small modifications are needed to the CHANGELOG to be able to release. To achieve this we invest a bit more time in every PR to document changes, but I think it requires less time to document something when you do it than after some days/weeks.

This may be useful: https://keepachangelog.com/en/1.0.0

What do you think? Should we give it a try?

@Ana06 Ana06 added enhancement New feature or request question Further information is requested labels Mar 9, 2021
@Ana06 Ana06 self-assigned this Mar 9, 2021
@Ana06
Copy link
Member Author

Ana06 commented Mar 9, 2021

This wouldn't include the rules as they are in a different repo, but the new rules could maybe be automatized with Github Actions once this is setup.

@williballenthin
Copy link
Collaborator

if you can create and maintain the gh action, i'm ok going forward with this plan.

i like the idea of having a PR template with the changelog details, too.

@Ana06 Ana06 modified the milestone: v2.0.0 Mar 11, 2021
@mr-tz mr-tz added the CI Continuous Integration configuration label Mar 22, 2021
@mr-tz mr-tz mentioned this issue Mar 23, 2021
@Ana06
Copy link
Member Author

Ana06 commented May 20, 2021

GitHub Action to enforce this is used. A check in PR will fail if the CHANGELOG is not modified and the no changelog (or similar name) tag is not used.

I have a good solution for this: request changes in a PR if the CHANGELOG hasn't been updated and the text No CHANGELOG update needed is not in the PR description with GitHub actions. If the CHANGELOG or the PR description is updated to meet the requirements, then the changes request is dimissed with GitHub actions). But I need to modify/fix https://github.com/AndrewMusgrave/automatic-pull-request-review and https://github.com/jitterbit/get-changed-files for it to work. I have submitted issues/PR and I am waiting for their input.

You can see the requests changes part working here: Ana06#28
The needed changes are in https://github.com/Ana06/capa/commits/master (they are using https://github.com/Ana06/automatic-pull-request-review and https://github.com/Ana06/get-changed-files, I have submitted those changes upstream).

Ana06 added a commit that referenced this issue May 28, 2021
Fix broken link to `pull_request_template.md` and add some more details.

Related #457
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Continuous Integration configuration enhancement New feature or request question Further information is requested
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants