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

Enable versions in titles of release PRs #9475

Closed
alicejli opened this issue May 30, 2023 · 4 comments · Fixed by #9546
Closed

Enable versions in titles of release PRs #9475

alicejli opened this issue May 30, 2023 · 4 comments · Fixed by #9546
Assignees
Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. type: process A process-related concern. May include testing, release, or the like.

Comments

@alicejli
Copy link
Contributor

Currently the release PRs for this repo have the title chore: release main (e.g. #9427). It would be great if we could have the version number as well as if it is a snapshot version in the title so it's easier to tell what version is getting released instead of having to click into the files. F

or example, java-bigquery has release PRs that look like this: chore(main): release 2.26.1 (googleapis/java-bigquery#2703) and chore(main): release 2.26.2-SNAPSHOT googleapis/java-bigquery#2704.

@alicejli alicejli added the priority: p3 Desirable enhancement or fix. May not be included in next release. label May 30, 2023
@suztomo
Copy link
Member

suztomo commented Jun 2, 2023

@alicejli Do you see any difference in yaml files that has release-please in their names between this repository and java-bigquery?

@alicejli
Copy link
Contributor Author

alicejli commented Jun 2, 2023

I suspect https://github.com/googleapis/google-cloud-java/blob/main/.github/release-please.yml#L3 is what is causing the discrepancy.

I see in the release-please documentation (https://github.com/googleapis/release-please/blob/main/docs/customizing.md#pull-request-title):

The default pull request title uses this pattern: chore${scope}: release${component} ${version} so a common release pull request title would be chore(main): release foo-bar v1.2.3.

Pattern | Description
-- | --
${scope} | This pattern is used for specifying the conventional commit scope (e.g. chore(scope): some message). We expect that the target branch name is used for the scope value
${component} | The name of the component being released
${version} | The version of the component being released
${branch?} | The target branch of the pull request. If you have multiple release branches, this helps identify which release branch we are working on

So it seems the issue is that release-please cannot find the ${scope}, ${component}, ${version} within the PR, or by using the .release-please-manifest.json file, we should update pullRequestTitlePattern to the pattern we want.

I will test out the latter next week and respond back with findings.

@ddixit14 ddixit14 added the type: process A process-related concern. May include testing, release, or the like. label Jun 5, 2023
@suztomo
Copy link
Member

suztomo commented Jun 9, 2023

A chance to try: #9516 (comment)

@suztomo
Copy link
Member

suztomo commented Jun 16, 2023

It worked in the latest Release Please PR. Thank you.

Screenshot 2023-06-16 at 6 10 10 PM

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: process A process-related concern. May include testing, release, or the like.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants