feat: add include-v-in-release-name config option#2633
Merged
chingor13 merged 1 commit intogoogleapis:mainfrom Dec 22, 2025
Merged
feat: add include-v-in-release-name config option#2633chingor13 merged 1 commit intogoogleapis:mainfrom
chingor13 merged 1 commit intogoogleapis:mainfrom
Conversation
This adds a new configuration option `include-v-in-release-name` that
controls whether the `v` prefix is included in GitHub release names.
Previously, the release name was hardcoded to always include the `v`
prefix (e.g., `v1.2.3`). This change allows users to opt out of the
`v` prefix by setting `include-v-in-release-name: false` in their
release-please config.
The default behavior is unchanged (`true`), maintaining backwards
compatibility.
Changes:
- Added `include-v-in-release-name` to config schema
- Added `includeVInReleaseName` to ReleaserConfig interface
- Updated BaseStrategy to use the new option when building release name
- Added serialization support in release-please-config updater
- Added tests for the new functionality
Example config:
```json
{
"include-v-in-tag": false,
"include-v-in-release-name": false,
"packages": {
".": {
"release-type": "node"
}
}
}
```
With the above config, releases would be named `1.2.3` instead of `v1.2.3`.
|
I was looking for that! Could this be reviewed? ❤️ |
ferrarimarco
approved these changes
Dec 12, 2025
chingor13
approved these changes
Dec 22, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds a new configuration option
include-v-in-release-namethat controls whether thevprefix is included in GitHub release names.Problem
Currently, the GitHub release name is hardcoded to always include the
vprefix (e.g.,v1.2.3). Users who prefer releases without thevprefix have no way to configure this. Whileinclude-v-in-tagexists to control the tag name, there's no equivalent for the release name.Solution
Added a new
include-v-in-release-nameboolean configuration option that:true(maintains backwards compatibility)false, creates releases without thevprefix (e.g.,1.2.3)include-v-in-tagto allow different formats for tags vs release namesChanges
include-v-in-release-nameproperty to the schemaincludeVInReleaseNametoReleaserConfiginterface and config parsingExample Config
{ "include-v-in-tag": false, "include-v-in-release-name": false, "packages": { ".": { "release-type": "node" } } }With this config:
1.2.31.2.3Use Case
Users who:
vvprefixvprefix for releasesThis follows the pattern established by the existing
include-v-in-tagoption and provides users with complete control over version prefix formatting.