Skip to content
This repository has been archived by the owner on May 14, 2024. It is now read-only.

Commit

Permalink
docs: document the types of releasers we support
Browse files Browse the repository at this point in the history
  • Loading branch information
bcoe committed May 21, 2020
1 parent 3815b6b commit 7ccaca9
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,17 @@ Automate releases with Conventional Commit Messages.
| package-name | A name for the artifact releases are being created for (this might be the `name` field in a `setup.py` or `package.json`) |
| bump-minor-pre-major | Should breaking changes before 1.0.0 produce minor bumps? Default `No` |

### Release types supported

Release Please automates releases for the following flavors of repositories:

| release type | description
|-------------------|---------------------------------------------------------|
| node | [A Node.js repository, with a package.json and CHANGELOG.md](https://github.com/yargs/yargs) |
| python | [A Python repository, with a setup.py, setup.cfg, and CHANGELOG.md](https://github.com/googleapis/java-storage) |
| terraform-module | [A terraform module, with a version in the README.md, and a CHANGELOG.md](https://github.com/terraform-google-modules/terraform-google-project-factory) |
| simple | [A repository with a version.txt and a CHANGELOG.md](https://github.com/googleapis/gapic-generator) |

## How release please works

Release Please automates CHANGELOG generation, the creation of GitHub releases,
Expand Down

0 comments on commit 7ccaca9

Please sign in to comment.