Skip to content

Commit 7e15914

Browse files
committed
docs: add clarifications for this change
1 parent 7d214ff commit 7e15914

File tree

2 files changed

+76
-1
lines changed

2 files changed

+76
-1
lines changed

docs/customizing.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,35 @@ If you wish to avoid that, consider using `component-no-space: true`/`--componen
116116
| `${version}` | The version of the component being released |
117117
| `${branch?}` | The target branch of the pull request. If you have multiple release branches, this helps identify which release branch we are working on |
118118

119+
#### Group Pull Request Title
120+
121+
For grouped/merged pull requests (when using plugins like `linked-versions` or when `separate-pull-requests` is `false`), you can use the `group-pull-request-title-pattern` option instead:
122+
123+
```json
124+
{
125+
"group-pull-request-title-pattern": "chore${scope}: release ${component} ${version}"
126+
}
127+
```
128+
129+
This pattern uses the same placeholders as `pull-request-title-pattern`. When used with the `linked-versions` plugin, the `${component}` placeholder will be replaced with the plugin's `groupName`.
130+
131+
For example, with the configuration:
132+
133+
```json
134+
{
135+
"group-pull-request-title-pattern": "chore${scope}: release ${component} ${version}",
136+
"plugins": [
137+
{
138+
"type": "linked-versions",
139+
"groupName": "my-sdk",
140+
"components": ["pkgA", "pkgB"]
141+
}
142+
]
143+
}
144+
```
145+
146+
The resulting pull request title will be: `chore(main): release my-sdk v1.2.3`
147+
119148
### Pull Request Header
120149

121150
If you would like to customize the pull request header, you can use the

docs/manifest-releaser.md

Lines changed: 47 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,6 +235,8 @@ defaults (those are documented in comments)
235235
// Template values (i.e. ${scope}, ${component} and ${version}) are inherited
236236
// from the root path's (i.e. '.') package, if present
237237
// absence defaults to "chore: release ${branch}"
238+
// Note: When used with the `linked-versions` plugin, ${component} will be
239+
// replaced with the plugin's groupName.
238240
"group-pull-request-title-pattern": "chore: release ${branch}",
239241

240242
// When searching for the latest release SHAs, only consider the last N releases.
@@ -568,7 +570,49 @@ Note: when combining the `linked-versions` plugin with a `workspace` plugin,
568570
you will need to tell the `workspace` plugin to skip its own internal merge.
569571
See #1457 for context.
570572

571-
Example:
573+
#### Pull Request Title Configuration
574+
575+
By default, the `linked-versions` plugin generates pull request titles with
576+
the format `chore(scope): release <groupName> libraries`. You can customize
577+
this by using the `group-pull-request-title-pattern` option:
578+
579+
```json
580+
{
581+
"release-type": "rust",
582+
"group-pull-request-title-pattern": "chore${scope}: release ${component} ${version}",
583+
"packages": {
584+
"packages/rustA": {
585+
"component": "pkgA"
586+
},
587+
"packages/rustB": {
588+
"component": "pkgB"
589+
}
590+
},
591+
"plugins": [
592+
{
593+
"type": "cargo-workspace",
594+
"merge": false
595+
},
596+
{
597+
"type": "linked-versions",
598+
"groupName": "my-sdk",
599+
"components": [
600+
"pkgA", "pkgB"
601+
]
602+
}
603+
]
604+
}
605+
```
606+
607+
With this configuration, the pull request title will be
608+
`chore(main): release my-sdk v1.2.3` instead of the default
609+
`chore(main): release my-sdk libraries`.
610+
611+
The `${component}` placeholder in the pattern will be replaced with the
612+
`groupName` from the plugin configuration. Other available placeholders are
613+
`${scope}`, `${version}`, and `${branch}`.
614+
615+
Example without configuration (backward compatibility):
572616

573617
```json
574618
{
@@ -597,6 +641,8 @@ Example:
597641
}
598642
```
599643

644+
This will use the default title: `chore(main): release my group libraries`.
645+
600646
### sentence-case
601647

602648
Capitalize the leading word in a commit message, taking into account common exceptions, e.g., gRPC.

0 commit comments

Comments
 (0)