Skip to content

Commit

Permalink
chore(docs): document how to change the version number of a release (#…
Browse files Browse the repository at this point in the history 
…166)

* update release footer

* update snapshots

* Tweak release PR footer

---------

Co-authored-by: Samuel El-Borai <sam@elborai.me>
  • Loading branch information
@dtmeadows @dgellow
dtmeadows and dgellow authored Aug 6, 2024
1 parent 188096b commit 2a15556
Show file tree
Hide file tree
Showing 16 changed files with 480 additions and 180 deletions.
33 changes: 24 additions & 9 deletions __snapshots__/base.ts.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,15 @@ exports['Strategy buildReleasePullRequest allows overriding initial version 1']
* initial commit ([16d3754](https://github.com/googleapis/base-test-repo/commit/16d3754a2134a6d19ee19d2e5ba4dfbc))
---
This Pull Request has been generated automatically as part of [Stainless](https://stainlessapi.com/)'s release process.
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)).
This pull request is managed by Stainless's [GitHub App](https://github.com/apps/stainless-app).
_More technical details can be found at [stainless-api/release-please](https://github.com/stainless-api/release-please)_.
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.
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request.
🔗 Stainless [website](https://www.stainlessapi.com)
📚 Read the [docs](https://app.stainlessapi.com/docs)
🙋 [Reach out](mailto:support@stainlessapi.com) for help or questions
`

exports['Strategy buildReleasePullRequest allows overriding initial version in base constructor 1'] = `
Expand All @@ -30,10 +35,15 @@ exports['Strategy buildReleasePullRequest allows overriding initial version in b
* initial commit ([a90fc00](https://github.com/googleapis/base-test-repo/commit/a90fc00ca62382346da72dd8f51078a7))
---
This Pull Request has been generated automatically as part of [Stainless](https://stainlessapi.com/)'s release process.
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)).
This pull request is managed by Stainless's [GitHub App](https://github.com/apps/stainless-app).
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.
_More technical details can be found at [stainless-api/release-please](https://github.com/stainless-api/release-please)_.
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request.
🔗 Stainless [website](https://www.stainlessapi.com)
📚 Read the [docs](https://app.stainlessapi.com/docs)
🙋 [Reach out](mailto:support@stainlessapi.com) for help or questions
`

exports['Strategy buildReleasePullRequest should pass changelogHost to default buildNotes 1'] = `
Expand All @@ -49,8 +59,13 @@ exports['Strategy buildReleasePullRequest should pass changelogHost to default b
* a bugfix ([6c1715c](https://example.com/googleapis/base-test-repo/commit/6c1715c07438036db68bb939cf36fe6f))
---
This Pull Request has been generated automatically as part of [Stainless](https://stainlessapi.com/)'s release process.
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)).
This pull request is managed by Stainless's [GitHub App](https://github.com/apps/stainless-app).
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.
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request.
_More technical details can be found at [stainless-api/release-please](https://github.com/stainless-api/release-please)_.
🔗 Stainless [website](https://www.stainlessapi.com)
📚 Read the [docs](https://app.stainlessapi.com/docs)
🙋 [Reach out](mailto:support@stainlessapi.com) for help or questions
`
121 changes: 88 additions & 33 deletions __snapshots__/cargo-workspace.ts.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,15 @@ Release notes for path: packages/rustA, releaseType: rust
</details>
---
This Pull Request has been generated automatically as part of [Stainless](https://stainlessapi.com/)'s release process.
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)).
This pull request is managed by Stainless's [GitHub App](https://github.com/apps/stainless-app).
_More technical details can be found at [stainless-api/release-please](https://github.com/stainless-api/release-please)_.
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.
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request.
🔗 Stainless [website](https://www.stainlessapi.com)
📚 Read the [docs](https://app.stainlessapi.com/docs)
🙋 [Reach out](mailto:support@stainlessapi.com) for help or questions
`

exports['CargoWorkspace plugin run can skip merging rust packages 1'] = `
Expand All @@ -51,10 +56,15 @@ exports['CargoWorkspace plugin run can skip merging rust packages 1'] = `
Release notes for path: packages/rustA, releaseType: rust
---
This Pull Request has been generated automatically as part of [Stainless](https://stainlessapi.com/)'s release process.
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)).
This pull request is managed by Stainless's [GitHub App](https://github.com/apps/stainless-app).
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.
_More technical details can be found at [stainless-api/release-please](https://github.com/stainless-api/release-please)_.
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request.
🔗 Stainless [website](https://www.stainlessapi.com)
📚 Read the [docs](https://app.stainlessapi.com/docs)
🙋 [Reach out](mailto:support@stainlessapi.com) for help or questions
`

exports['CargoWorkspace plugin run can skip merging rust packages 2'] = `
Expand All @@ -69,10 +79,15 @@ exports['CargoWorkspace plugin run can skip merging rust packages 2'] = `
* pkgA bumped from 1.1.1 to 1.1.2
---
This Pull Request has been generated automatically as part of [Stainless](https://stainlessapi.com/)'s release process.
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)).
This pull request is managed by Stainless's [GitHub App](https://github.com/apps/stainless-app).
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.
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request.
_More technical details can be found at [stainless-api/release-please](https://github.com/stainless-api/release-please)_.
🔗 Stainless [website](https://www.stainlessapi.com)
📚 Read the [docs](https://app.stainlessapi.com/docs)
🙋 [Reach out](mailto:support@stainlessapi.com) for help or questions
`

exports['CargoWorkspace plugin run can skip merging rust packages 3'] = `
Expand All @@ -87,10 +102,15 @@ exports['CargoWorkspace plugin run can skip merging rust packages 3'] = `
* pkgB bumped from 2.2.2 to 2.2.3
---
This Pull Request has been generated automatically as part of [Stainless](https://stainlessapi.com/)'s release process.
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)).
This pull request is managed by Stainless's [GitHub App](https://github.com/apps/stainless-app).
_More technical details can be found at [stainless-api/release-please](https://github.com/stainless-api/release-please)_.
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.
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request.
🔗 Stainless [website](https://www.stainlessapi.com)
📚 Read the [docs](https://app.stainlessapi.com/docs)
🙋 [Reach out](mailto:support@stainlessapi.com) for help or questions
`

exports['CargoWorkspace plugin run can skip merging rust packages 4'] = `
Expand All @@ -101,10 +121,15 @@ exports['CargoWorkspace plugin run can skip merging rust packages 4'] = `
Release notes for path: packages/rustD, releaseType: rust
---
This Pull Request has been generated automatically as part of [Stainless](https://stainlessapi.com/)'s release process.
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)).
This pull request is managed by Stainless's [GitHub App](https://github.com/apps/stainless-app).
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.
_More technical details can be found at [stainless-api/release-please](https://github.com/stainless-api/release-please)_.
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request.
🔗 Stainless [website](https://www.stainlessapi.com)
📚 Read the [docs](https://app.stainlessapi.com/docs)
🙋 [Reach out](mailto:support@stainlessapi.com) for help or questions
`

exports['CargoWorkspace plugin run can skip merging rust packages 5'] = `
Expand All @@ -119,10 +144,15 @@ exports['CargoWorkspace plugin run can skip merging rust packages 5'] = `
* pkgA bumped from 1.1.1 to 1.1.2
---
This Pull Request has been generated automatically as part of [Stainless](https://stainlessapi.com/)'s release process.
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)).
This pull request is managed by Stainless's [GitHub App](https://github.com/apps/stainless-app).
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.
_More technical details can be found at [stainless-api/release-please](https://github.com/stainless-api/release-please)_.
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request.
🔗 Stainless [website](https://www.stainlessapi.com)
📚 Read the [docs](https://app.stainlessapi.com/docs)
🙋 [Reach out](mailto:support@stainlessapi.com) for help or questions
`

exports['CargoWorkspace plugin run combines rust packages 1'] = `
Expand All @@ -141,10 +171,15 @@ Release notes for path: packages/rustD, releaseType: rust
</details>
---
This Pull Request has been generated automatically as part of [Stainless](https://stainlessapi.com/)'s release process.
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)).
This pull request is managed by Stainless's [GitHub App](https://github.com/apps/stainless-app).
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.
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request.
_More technical details can be found at [stainless-api/release-please](https://github.com/stainless-api/release-please)_.
🔗 Stainless [website](https://www.stainlessapi.com)
📚 Read the [docs](https://app.stainlessapi.com/docs)
🙋 [Reach out](mailto:support@stainlessapi.com) for help or questions
`

exports['CargoWorkspace plugin run handles a single rust package 1'] = `
Expand All @@ -158,10 +193,15 @@ Release notes for path: packages/rustA, releaseType: rust
</details>
---
This Pull Request has been generated automatically as part of [Stainless](https://stainlessapi.com/)'s release process.
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)).
This pull request is managed by Stainless's [GitHub App](https://github.com/apps/stainless-app).
_More technical details can be found at [stainless-api/release-please](https://github.com/stainless-api/release-please)_.
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.
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request.
🔗 Stainless [website](https://www.stainlessapi.com)
📚 Read the [docs](https://app.stainlessapi.com/docs)
🙋 [Reach out](mailto:support@stainlessapi.com) for help or questions
`

exports['CargoWorkspace plugin run handles glob paths 1'] = `
Expand All @@ -180,10 +220,15 @@ Release notes for path: packages/rustD, releaseType: rust
</details>
---
This Pull Request has been generated automatically as part of [Stainless](https://stainlessapi.com/)'s release process.
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)).
This pull request is managed by Stainless's [GitHub App](https://github.com/apps/stainless-app).
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.
_More technical details can be found at [stainless-api/release-please](https://github.com/stainless-api/release-please)_.
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request.
🔗 Stainless [website](https://www.stainlessapi.com)
📚 Read the [docs](https://app.stainlessapi.com/docs)
🙋 [Reach out](mailto:support@stainlessapi.com) for help or questions
`

exports['CargoWorkspace plugin run skips component if not touched 1'] = `
Expand All @@ -206,10 +251,15 @@ Release notes for path: packages/rustB, releaseType: rust
</details>
---
This Pull Request has been generated automatically as part of [Stainless](https://stainlessapi.com/)'s release process.
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)).
This pull request is managed by Stainless's [GitHub App](https://github.com/apps/stainless-app).
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.
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request.
_More technical details can be found at [stainless-api/release-please](https://github.com/stainless-api/release-please)_.
🔗 Stainless [website](https://www.stainlessapi.com)
📚 Read the [docs](https://app.stainlessapi.com/docs)
🙋 [Reach out](mailto:support@stainlessapi.com) for help or questions
`

exports['CargoWorkspace plugin run walks dependency tree and updates previously untouched packages 1'] = `
Expand Down Expand Up @@ -255,8 +305,13 @@ Release notes for path: packages/rustD, releaseType: rust
</details>
---
This Pull Request has been generated automatically as part of [Stainless](https://stainlessapi.com/)'s release process.
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)).
This pull request is managed by Stainless's [GitHub App](https://github.com/apps/stainless-app).
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.
For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request.
_More technical details can be found at [stainless-api/release-please](https://github.com/stainless-api/release-please)_.
🔗 Stainless [website](https://www.stainlessapi.com)
📚 Read the [docs](https://app.stainlessapi.com/docs)
🙋 [Reach out](mailto:support@stainlessapi.com) for help or questions
`
Loading

0 comments on commit 2a15556

Please sign in to comment.