From 7ccaca965e38e1a5d611b3f784fc62b9bfe980d9 Mon Sep 17 00:00:00 2001 From: bcoe Date: Thu, 21 May 2020 09:55:36 -0700 Subject: [PATCH] docs: document the types of releasers we support --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index c0a57d3..c4b277f 100644 --- a/README.md +++ b/README.md @@ -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,