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.

Sign up for GitHub

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

Jump to bottom

docs: update release docs #1301

Merged
merged 2 commits into from
Dec 20, 2023
Merged

docs: update release docs #1301

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bfea831
docs: update release docs
andrei-scripniciuc Dec 19, 2023
1752107
docs: correct tag is fix, not bug
andrei-scripniciuc Dec 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions docs/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,9 +135,12 @@ If a proto block _begins with_ a comment that says only `Incorrect.` or

## Releases

Releases are handled automatically by [release-please][]. If a manual release
is desired, simply open a pull request with an empty commit and the proper
conventional commit message for the desired semver bump. For example:
Releases are handled automatically by [release-please][] by sending PRs
after changes starting with `fix:` or `feat:` have been merged.
[example release pr][].

If a manual release is desired, simply open a pull request with an empty commit
and the proper conventional commit message for the desired semver bump. For example:

```sh
# releasing a minor version
Expand All @@ -156,4 +159,5 @@ git commit --allow-empty -m 'fix: new patch release'
[`rules.go`]: https://github.com/googleapis/api-linter/blob/main/rules/rules.go
[visitor pattern]: https://en.wikipedia.org/wiki/Visitor_pattern
[release-please]: https://github.com/googleapis/release-please
[example release pr]: https://github.com/googleapis/api-linter/pull/1290
<!-- prettier-ignore-end -->