Skip to content

Commit

Permalink
docs: update release docs (#1301)
Browse files Browse the repository at this point in the history
* docs: update release docs

* docs: correct tag is fix, not bug
  • Loading branch information
andrei-scripniciuc committed Dec 20, 2023
1 parent 77de59f commit 3cfd411
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions docs/contributing.md
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 -->

0 comments on commit 3cfd411

Please sign in to comment.