Skip to content

Commit 2a15556

Browse files
dtmeadowsdgellow
dtmeadows
and
dgellow
authored
chore(docs): document how to change the version number of a release (#166)
* update release footer * update snapshots * Tweak release PR footer --------- Co-authored-by: Samuel El-Borai <sam@elborai.me>
1 parent 188096b commit 2a15556

16 files changed

Lines changed: 480 additions & 180 deletions

‎__snapshots__/base.ts.js‎

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,15 @@ exports['Strategy buildReleasePullRequest allows overriding initial version 1']
1111
* initial commit ([16d3754](https://github.com/googleapis/base-test-repo/commit/16d3754a2134a6d19ee19d2e5ba4dfbc))
1212
1313
---
14-
This Pull Request has been generated automatically as part of [Stainless](https://stainlessapi.com/)'s release process.
15-
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request ([see details](https://github.com/stainless-api/release-please/#linear-git-commit-history-use-squash-merge)).
14+
This pull request is managed by Stainless's [GitHub App](https://github.com/apps/stainless-app).
1615
17-
_More technical details can be found at [stainless-api/release-please](https://github.com/stainless-api/release-please)_.
16+
The [semver version number](https://semver.org/#semantic-versioning-specification-semver) is based on included [commit messages](https://www.conventionalcommits.org/en/v1.0.0/). Alternatively, you can manually set the version number in the title of this pull request.
17+
18+
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request.
19+
20+
🔗 Stainless [website](https://www.stainlessapi.com)
21+
📚 Read the [docs](https://app.stainlessapi.com/docs)
22+
🙋 [Reach out](mailto:support@stainlessapi.com) for help or questions
1823
`
1924

2025
exports['Strategy buildReleasePullRequest allows overriding initial version in base constructor 1'] = `
@@ -30,10 +35,15 @@ exports['Strategy buildReleasePullRequest allows overriding initial version in b
3035
* initial commit ([a90fc00](https://github.com/googleapis/base-test-repo/commit/a90fc00ca62382346da72dd8f51078a7))
3136
3237
---
33-
This Pull Request has been generated automatically as part of [Stainless](https://stainlessapi.com/)'s release process.
34-
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request ([see details](https://github.com/stainless-api/release-please/#linear-git-commit-history-use-squash-merge)).
38+
This pull request is managed by Stainless's [GitHub App](https://github.com/apps/stainless-app).
39+
40+
The [semver version number](https://semver.org/#semantic-versioning-specification-semver) is based on included [commit messages](https://www.conventionalcommits.org/en/v1.0.0/). Alternatively, you can manually set the version number in the title of this pull request.
3541
36-
_More technical details can be found at [stainless-api/release-please](https://github.com/stainless-api/release-please)_.
42+
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request.
43+
44+
🔗 Stainless [website](https://www.stainlessapi.com)
45+
📚 Read the [docs](https://app.stainlessapi.com/docs)
46+
🙋 [Reach out](mailto:support@stainlessapi.com) for help or questions
3747
`
3848

3949
exports['Strategy buildReleasePullRequest should pass changelogHost to default buildNotes 1'] = `
@@ -49,8 +59,13 @@ exports['Strategy buildReleasePullRequest should pass changelogHost to default b
4959
* a bugfix ([6c1715c](https://example.com/googleapis/base-test-repo/commit/6c1715c07438036db68bb939cf36fe6f))
5060
5161
---
52-
This Pull Request has been generated automatically as part of [Stainless](https://stainlessapi.com/)'s release process.
53-
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request ([see details](https://github.com/stainless-api/release-please/#linear-git-commit-history-use-squash-merge)).
62+
This pull request is managed by Stainless's [GitHub App](https://github.com/apps/stainless-app).
63+
64+
The [semver version number](https://semver.org/#semantic-versioning-specification-semver) is based on included [commit messages](https://www.conventionalcommits.org/en/v1.0.0/). Alternatively, you can manually set the version number in the title of this pull request.
65+
66+
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request.
5467
55-
_More technical details can be found at [stainless-api/release-please](https://github.com/stainless-api/release-please)_.
68+
🔗 Stainless [website](https://www.stainlessapi.com)
69+
📚 Read the [docs](https://app.stainlessapi.com/docs)
70+
🙋 [Reach out](mailto:support@stainlessapi.com) for help or questions
5671
`

‎__snapshots__/cargo-workspace.ts.js‎

Lines changed: 88 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,15 @@ Release notes for path: packages/rustA, releaseType: rust
3737
</details>
3838
3939
---
40-
This Pull Request has been generated automatically as part of [Stainless](https://stainlessapi.com/)'s release process.
41-
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request ([see details](https://github.com/stainless-api/release-please/#linear-git-commit-history-use-squash-merge)).
40+
This pull request is managed by Stainless's [GitHub App](https://github.com/apps/stainless-app).
4241
43-
_More technical details can be found at [stainless-api/release-please](https://github.com/stainless-api/release-please)_.
42+
The [semver version number](https://semver.org/#semantic-versioning-specification-semver) is based on included [commit messages](https://www.conventionalcommits.org/en/v1.0.0/). Alternatively, you can manually set the version number in the title of this pull request.
43+
44+
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request.
45+
46+
🔗 Stainless [website](https://www.stainlessapi.com)
47+
📚 Read the [docs](https://app.stainlessapi.com/docs)
48+
🙋 [Reach out](mailto:support@stainlessapi.com) for help or questions
4449
`
4550

4651
exports['CargoWorkspace plugin run can skip merging rust packages 1'] = `
@@ -51,10 +56,15 @@ exports['CargoWorkspace plugin run can skip merging rust packages 1'] = `
5156
Release notes for path: packages/rustA, releaseType: rust
5257
5358
---
54-
This Pull Request has been generated automatically as part of [Stainless](https://stainlessapi.com/)'s release process.
55-
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request ([see details](https://github.com/stainless-api/release-please/#linear-git-commit-history-use-squash-merge)).
59+
This pull request is managed by Stainless's [GitHub App](https://github.com/apps/stainless-app).
60+
61+
The [semver version number](https://semver.org/#semantic-versioning-specification-semver) is based on included [commit messages](https://www.conventionalcommits.org/en/v1.0.0/). Alternatively, you can manually set the version number in the title of this pull request.
5662
57-
_More technical details can be found at [stainless-api/release-please](https://github.com/stainless-api/release-please)_.
63+
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request.
64+
65+
🔗 Stainless [website](https://www.stainlessapi.com)
66+
📚 Read the [docs](https://app.stainlessapi.com/docs)
67+
🙋 [Reach out](mailto:support@stainlessapi.com) for help or questions
5868
`
5969

6070
exports['CargoWorkspace plugin run can skip merging rust packages 2'] = `
@@ -69,10 +79,15 @@ exports['CargoWorkspace plugin run can skip merging rust packages 2'] = `
6979
* pkgA bumped from 1.1.1 to 1.1.2
7080
7181
---
72-
This Pull Request has been generated automatically as part of [Stainless](https://stainlessapi.com/)'s release process.
73-
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request ([see details](https://github.com/stainless-api/release-please/#linear-git-commit-history-use-squash-merge)).
82+
This pull request is managed by Stainless's [GitHub App](https://github.com/apps/stainless-app).
83+
84+
The [semver version number](https://semver.org/#semantic-versioning-specification-semver) is based on included [commit messages](https://www.conventionalcommits.org/en/v1.0.0/). Alternatively, you can manually set the version number in the title of this pull request.
85+
86+
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request.
7487
75-
_More technical details can be found at [stainless-api/release-please](https://github.com/stainless-api/release-please)_.
88+
🔗 Stainless [website](https://www.stainlessapi.com)
89+
📚 Read the [docs](https://app.stainlessapi.com/docs)
90+
🙋 [Reach out](mailto:support@stainlessapi.com) for help or questions
7691
`
7792

7893
exports['CargoWorkspace plugin run can skip merging rust packages 3'] = `
@@ -87,10 +102,15 @@ exports['CargoWorkspace plugin run can skip merging rust packages 3'] = `
87102
* pkgB bumped from 2.2.2 to 2.2.3
88103
89104
---
90-
This Pull Request has been generated automatically as part of [Stainless](https://stainlessapi.com/)'s release process.
91-
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request ([see details](https://github.com/stainless-api/release-please/#linear-git-commit-history-use-squash-merge)).
105+
This pull request is managed by Stainless's [GitHub App](https://github.com/apps/stainless-app).
92106
93-
_More technical details can be found at [stainless-api/release-please](https://github.com/stainless-api/release-please)_.
107+
The [semver version number](https://semver.org/#semantic-versioning-specification-semver) is based on included [commit messages](https://www.conventionalcommits.org/en/v1.0.0/). Alternatively, you can manually set the version number in the title of this pull request.
108+
109+
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request.
110+
111+
🔗 Stainless [website](https://www.stainlessapi.com)
112+
📚 Read the [docs](https://app.stainlessapi.com/docs)
113+
🙋 [Reach out](mailto:support@stainlessapi.com) for help or questions
94114
`
95115

96116
exports['CargoWorkspace plugin run can skip merging rust packages 4'] = `
@@ -101,10 +121,15 @@ exports['CargoWorkspace plugin run can skip merging rust packages 4'] = `
101121
Release notes for path: packages/rustD, releaseType: rust
102122
103123
---
104-
This Pull Request has been generated automatically as part of [Stainless](https://stainlessapi.com/)'s release process.
105-
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request ([see details](https://github.com/stainless-api/release-please/#linear-git-commit-history-use-squash-merge)).
124+
This pull request is managed by Stainless's [GitHub App](https://github.com/apps/stainless-app).
125+
126+
The [semver version number](https://semver.org/#semantic-versioning-specification-semver) is based on included [commit messages](https://www.conventionalcommits.org/en/v1.0.0/). Alternatively, you can manually set the version number in the title of this pull request.
106127
107-
_More technical details can be found at [stainless-api/release-please](https://github.com/stainless-api/release-please)_.
128+
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request.
129+
130+
🔗 Stainless [website](https://www.stainlessapi.com)
131+
📚 Read the [docs](https://app.stainlessapi.com/docs)
132+
🙋 [Reach out](mailto:support@stainlessapi.com) for help or questions
108133
`
109134

110135
exports['CargoWorkspace plugin run can skip merging rust packages 5'] = `
@@ -119,10 +144,15 @@ exports['CargoWorkspace plugin run can skip merging rust packages 5'] = `
119144
* pkgA bumped from 1.1.1 to 1.1.2
120145
121146
---
122-
This Pull Request has been generated automatically as part of [Stainless](https://stainlessapi.com/)'s release process.
123-
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request ([see details](https://github.com/stainless-api/release-please/#linear-git-commit-history-use-squash-merge)).
147+
This pull request is managed by Stainless's [GitHub App](https://github.com/apps/stainless-app).
148+
149+
The [semver version number](https://semver.org/#semantic-versioning-specification-semver) is based on included [commit messages](https://www.conventionalcommits.org/en/v1.0.0/). Alternatively, you can manually set the version number in the title of this pull request.
124150
125-
_More technical details can be found at [stainless-api/release-please](https://github.com/stainless-api/release-please)_.
151+
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request.
152+
153+
🔗 Stainless [website](https://www.stainlessapi.com)
154+
📚 Read the [docs](https://app.stainlessapi.com/docs)
155+
🙋 [Reach out](mailto:support@stainlessapi.com) for help or questions
126156
`
127157

128158
exports['CargoWorkspace plugin run combines rust packages 1'] = `
@@ -141,10 +171,15 @@ Release notes for path: packages/rustD, releaseType: rust
141171
</details>
142172
143173
---
144-
This Pull Request has been generated automatically as part of [Stainless](https://stainlessapi.com/)'s release process.
145-
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request ([see details](https://github.com/stainless-api/release-please/#linear-git-commit-history-use-squash-merge)).
174+
This pull request is managed by Stainless's [GitHub App](https://github.com/apps/stainless-app).
175+
176+
The [semver version number](https://semver.org/#semantic-versioning-specification-semver) is based on included [commit messages](https://www.conventionalcommits.org/en/v1.0.0/). Alternatively, you can manually set the version number in the title of this pull request.
177+
178+
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request.
146179
147-
_More technical details can be found at [stainless-api/release-please](https://github.com/stainless-api/release-please)_.
180+
🔗 Stainless [website](https://www.stainlessapi.com)
181+
📚 Read the [docs](https://app.stainlessapi.com/docs)
182+
🙋 [Reach out](mailto:support@stainlessapi.com) for help or questions
148183
`
149184

150185
exports['CargoWorkspace plugin run handles a single rust package 1'] = `
@@ -158,10 +193,15 @@ Release notes for path: packages/rustA, releaseType: rust
158193
</details>
159194
160195
---
161-
This Pull Request has been generated automatically as part of [Stainless](https://stainlessapi.com/)'s release process.
162-
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request ([see details](https://github.com/stainless-api/release-please/#linear-git-commit-history-use-squash-merge)).
196+
This pull request is managed by Stainless's [GitHub App](https://github.com/apps/stainless-app).
163197
164-
_More technical details can be found at [stainless-api/release-please](https://github.com/stainless-api/release-please)_.
198+
The [semver version number](https://semver.org/#semantic-versioning-specification-semver) is based on included [commit messages](https://www.conventionalcommits.org/en/v1.0.0/). Alternatively, you can manually set the version number in the title of this pull request.
199+
200+
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request.
201+
202+
🔗 Stainless [website](https://www.stainlessapi.com)
203+
📚 Read the [docs](https://app.stainlessapi.com/docs)
204+
🙋 [Reach out](mailto:support@stainlessapi.com) for help or questions
165205
`
166206

167207
exports['CargoWorkspace plugin run handles glob paths 1'] = `
@@ -180,10 +220,15 @@ Release notes for path: packages/rustD, releaseType: rust
180220
</details>
181221
182222
---
183-
This Pull Request has been generated automatically as part of [Stainless](https://stainlessapi.com/)'s release process.
184-
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request ([see details](https://github.com/stainless-api/release-please/#linear-git-commit-history-use-squash-merge)).
223+
This pull request is managed by Stainless's [GitHub App](https://github.com/apps/stainless-app).
224+
225+
The [semver version number](https://semver.org/#semantic-versioning-specification-semver) is based on included [commit messages](https://www.conventionalcommits.org/en/v1.0.0/). Alternatively, you can manually set the version number in the title of this pull request.
185226
186-
_More technical details can be found at [stainless-api/release-please](https://github.com/stainless-api/release-please)_.
227+
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request.
228+
229+
🔗 Stainless [website](https://www.stainlessapi.com)
230+
📚 Read the [docs](https://app.stainlessapi.com/docs)
231+
🙋 [Reach out](mailto:support@stainlessapi.com) for help or questions
187232
`
188233

189234
exports['CargoWorkspace plugin run skips component if not touched 1'] = `
@@ -206,10 +251,15 @@ Release notes for path: packages/rustB, releaseType: rust
206251
</details>
207252
208253
---
209-
This Pull Request has been generated automatically as part of [Stainless](https://stainlessapi.com/)'s release process.
210-
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request ([see details](https://github.com/stainless-api/release-please/#linear-git-commit-history-use-squash-merge)).
254+
This pull request is managed by Stainless's [GitHub App](https://github.com/apps/stainless-app).
255+
256+
The [semver version number](https://semver.org/#semantic-versioning-specification-semver) is based on included [commit messages](https://www.conventionalcommits.org/en/v1.0.0/). Alternatively, you can manually set the version number in the title of this pull request.
257+
258+
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request.
211259
212-
_More technical details can be found at [stainless-api/release-please](https://github.com/stainless-api/release-please)_.
260+
🔗 Stainless [website](https://www.stainlessapi.com)
261+
📚 Read the [docs](https://app.stainlessapi.com/docs)
262+
🙋 [Reach out](mailto:support@stainlessapi.com) for help or questions
213263
`
214264

215265
exports['CargoWorkspace plugin run walks dependency tree and updates previously untouched packages 1'] = `
@@ -255,8 +305,13 @@ Release notes for path: packages/rustD, releaseType: rust
255305
</details>
256306
257307
---
258-
This Pull Request has been generated automatically as part of [Stainless](https://stainlessapi.com/)'s release process.
259-
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request ([see details](https://github.com/stainless-api/release-please/#linear-git-commit-history-use-squash-merge)).
308+
This pull request is managed by Stainless's [GitHub App](https://github.com/apps/stainless-app).
309+
310+
The [semver version number](https://semver.org/#semantic-versioning-specification-semver) is based on included [commit messages](https://www.conventionalcommits.org/en/v1.0.0/). Alternatively, you can manually set the version number in the title of this pull request.
311+
312+
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request.
260313
261-
_More technical details can be found at [stainless-api/release-please](https://github.com/stainless-api/release-please)_.
314+
🔗 Stainless [website](https://www.stainlessapi.com)
315+
📚 Read the [docs](https://app.stainlessapi.com/docs)
316+
🙋 [Reach out](mailto:support@stainlessapi.com) for help or questions
262317
`

0 commit comments

Comments
 (0)