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

Support using PR title instead of commit heading when generating changelogs and release notes #2342

Open
ferrarimarco opened this issue Jul 30, 2024 · 2 comments
Assignees
Labels
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

@ferrarimarco
Copy link

ferrarimarco commented Jul 30, 2024

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

In our repository, we enabled automated dependency updates using tools such as Dependabot and Renovate Bot. These tools create PRs with titles that have details about the versions of dependencies being updated. The heading of commit messages in those PRs are shorter to (try to) make them compliant with the Conventional Commits spec when they might overflow a certain length.

As release-please pulls the commit title to write it in the changelog and in release-notes, it might obfuscate the version information.

Example:

PR title: deps(docker): bump dotnet/sdk from 8.0.302-alpine3.20 to 8.0.303-alpine3.20
Commit heading: deps(docker): bump dotnet/sdk
Commit description:

Bumps dotnet/sdk from 8.0.302-alpine3.20 to 8.0.303-alpine3.20.

---
updated-dependencies:
- dependency-name: dotnet/sdk
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Resulting changelog and release notes line: docker: bump dotnet/sdk (link to PR) (link to commit)

Describe the solution you'd like

A configurable option to use the PR title instead of the commit heading to generate the changelog and the release notes.

Desired changelog and release notes line: deps(docker): bump dotnet/sdk from 8.0.302-alpine3.20 to 8.0.303-alpine3.20 (link to PR) (link to commit)

Describe alternatives you've considered

Manually rewriting release notes might be an option, although it doesn't scale.

Additional context

Nothing for now.

Thanks for your support!

@ferrarimarco ferrarimarco 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 Jul 30, 2024
@kevcube
Copy link

kevcube commented Sep 12, 2024

@ferrarimarco change your github settings so that squash merge commit title is PR title and enforce conventional PR titles instead of conventional commits

@ferrarimarco
Copy link
Author

Hi @kevcube ! We don't have too much control over PR titles because they are automatically generated by dependabot.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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
Development

No branches or pull requests

3 participants