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

Update release PR on every change (instead of only changes that modify the changelog) #1459

Closed
dnephin opened this issue Jun 1, 2022 · 5 comments · Fixed by #2420 · May be fixed by #2337
Closed

Update release PR on every change (instead of only changes that modify the changelog) #1459

dnephin opened this issue Jun 1, 2022 · 5 comments · Fixed by #2420 · May be fixed by #2337
Labels
help wanted We'd love to have community involvement on this issue. priority: p3 Desirable enhancement or fix. May not be included in next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.

Comments

@dnephin
Copy link

dnephin commented Jun 1, 2022 •
edited
Loading

Is your feature request related to a problem? Please describe.

We've been using release-please to manage our release and changelog. We've noticed that the release PR is only updated if the PR includes a commit with either fix: or feat:.

Sometimes we have PRs that add tests or fix problems with our release workflows. We'd like to include those commits in the release branch, but we don't want them to be included in the changelog (because our users aren't interested in those changes).

I wasn't able to find any option to make this happen, so I'm assuming it's not possible right now.

Describe the solution you'd like

I'd like to be able to configure release-please so that all changes that go into main are included in the release PR, but only the categories that are "not hidden" are added to the changelog.

Either a top-level setting, or a new field in the changelog-sections would work fine for us.

Describe alternatives you've considered

Not sure about any alternatives.

Thank you for your consideration!
@dnephin dnephin added priority: p3 Desirable enhancement or fix. May not be included in next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. labels Jun 1, 2022
@alioguzhan
Copy link

alioguzhan commented Aug 7, 2022 •
edited
Loading

This is also an issue for us. We would like to see every commit in the PR, regardless of the commit type. Here is the scenario:

  1. Push a feat: xxx commit to the main branch.
  2. Release-Please creates a PR for a new release. (it is a feat commit after all)
  3. I push another chore: xxx commit to the main branch.
  4. Release-please DOES NOT rebase its own PR branch. So my chore commit is not included in the upcoming release.

This can be verified by checking out to release-please branch in your machine. My chore commit won't be in the commit history. It would be something like this:

- chore(main): release 0.2.0
- feat: xxxxx
- ....

Yet it should be:

- chore(main): release 0.2.0
- chore(deps): xxxxx
- feat: xxxxx
- ....

@chingor13 chingor13 added the help wanted We'd love to have community involvement on this issue. label Aug 19, 2022
@chingor13
Copy link
Contributor

This seems like a reasonable option to add. We would likely want to implement it as an option for the manifest like always-update (default to false, the current behavior).

We intentionally implemented it to only push on changes to not overload our CI systems when we have many non-release-note-worthy commits.

@jimeh
Copy link

jimeh commented Nov 21, 2022

I'd love to see always-update option myself too. @chingor13 any update on this?

@tabfugnic
Copy link

@chingor13 Makes sense not to overload the CI systems. I could also be something like keep-main-synced and defaulting to true so that it doesn't change the release behavior outwardly, but does ensure that the Release PR is always up-to-date with main

Understand that's still a breaking change, but feels like a sensible default.

@adambiggs
Copy link

Any progress on this? We have Renovate configured to auto-merge safe dependency updates, and would like these updates to be included in release PRs.

Currently workaround is to set a custom changelog-types that includes chore commits in the changelog, but something like always-update would fix the issue without adding any clutter our CHANGELOG.md.

Another option that would give more control might be something like update-types, where we could specify commit types that would trigger a PR rebase separately from those that trigger a changelog update:

update-types:
  - feat
  - fix
  - chore

Would be even more powerful if you could include scope:

update-types:
  - feat
  - fix
  - chore(deps)

meyfa added a commit to meyfa/release-please that referenced this issue Jul 14, 2024
@meyfa
feat: add "always-update" config option
0b387bb 
Fixes googleapis#1459

This patch adds a new option "always-update" that forces existing pull
requests to be updated even when there are no changes to the
release notes. This is useful, for example, when the repository
enforces pull requests to be up-to-date with the main branch before
they can be merged. Without this option set to `true`, that is, with the
default behavior of release-please, if the last commit made to the
main branch does not appear in the release notes, the existing pull
request branch would not be rebased.
@meyfa meyfa mentioned this issue Jul 14, 2024
Open
4 tasks
@zirkelc zirkelc mentioned this issue Nov 6, 2024
Merged
github-merge-queue bot pushed a commit that referenced this issue Nov 12, 2024
@zirkelc @meyfa @chingor13
feat: always-update (#2420)
72d40df 
* feat: add "always-update" config option

Fixes #1459

This patch adds a new option "always-update" that forces existing pull
requests to be updated even when there are no changes to the
release notes. This is useful, for example, when the repository
enforces pull requests to be up-to-date with the main branch before
they can be merged. Without this option set to `true`, that is, with the
default behavior of release-please, if the last commit made to the
main branch does not appear in the release notes, the existing pull
request branch would not be rebased.

* feat: apply suggested changes

---------

Co-authored-by: Fabian Meyer <[email protected]>
Co-authored-by: Jeff Ching <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
help wanted We'd love to have community involvement on this issue. priority: p3 Desirable enhancement or fix. May not be included in next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.
Projects
None yet
Milestone
No milestone
6 participants
@chingor13 @jimeh @dnephin @tabfugnic @adambiggs @alioguzhan