From b2dd1ed06a36feb74341377cf749b2a3280e1f39 Mon Sep 17 00:00:00 2001 From: Jonathan Netley Date: Wed, 20 Apr 2022 19:34:11 +0200 Subject: [PATCH] docs(readme): command explanation (#434) --- README.md | 32 +++++++++++++++++++++----------- 1 file changed, 21 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 74ff157..1c524d2 100644 --- a/README.md +++ b/README.md @@ -66,17 +66,12 @@ Automate releases with Conventional Commit Messages. | `repo-url` | configure github repository URL. Default `process.env.GITHUB_REPOSITORY` | | `github-graphql-url` | configure github GraphQL URL. Default `https://api.github.com` | -| output | description | -|:---:|---| -| `release_created` | `true` if the release was created, `false` otherwise | -| `upload_url` | Directly related to [**Create a release**](https://developer.github.com/v3/repos/releases/#response-4) API | -| `html_url` | Directly related to [**Create a release**](https://developer.github.com/v3/repos/releases/#response-4) API | -| `tag_name` | Directly related to [**Create a release**](https://developer.github.com/v3/repos/releases/#response-4) API | -| `major` | Number representing major semver value | -| `minor` | Number representing minor semver value | -| `patch` | Number representing patch semver value | -| `sha` | sha that a GitHub release was tagged at | -| `pr` | The PR number of an opened release (undefined if no release created) | +### The `command` option +Some additional info regarding the `command` property. +- `github-release`: creates GitHub releases (as mentioned [here](https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases)) based on the most recently merged release PR and the release strategy being used. +- `release-pr`: uses Conventional Commits to propose a candidate release [pull request](#how-release-please-works). This pull request, once merged, is used by `github-release`/`manifest` +- `manifest`: use [source controlled files](https://github.com/googleapis/release-please/blob/main/docs/manifest-releaser.md#manifest-driven-release-please) containing releaser specific configuration (the `release-please-config.json`) as well package version tracking (the `.release-please-manifest.json`). +- `manifest-pr`: uses the manifest file `release-please-config.json` to propose a candidate release ### Release types supported @@ -98,6 +93,21 @@ Release Please automates releases for the following flavors of repositories: | `simple` | [A repository with a version.txt and a CHANGELOG.md](https://github.com/googleapis/gapic-generator) | | `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) | +## Outputs +> Properties that are available after the action executed. + +| output | description | +|:---:|---| +| `release_created` | `true` if the release was created, `false` otherwise | +| `upload_url` | Directly related to [**Create a release**](https://developer.github.com/v3/repos/releases/#response-4) API | +| `html_url` | Directly related to [**Create a release**](https://developer.github.com/v3/repos/releases/#response-4) API | +| `tag_name` | Directly related to [**Create a release**](https://developer.github.com/v3/repos/releases/#response-4) API | +| `major` | Number representing major semver value | +| `minor` | Number representing minor semver value | +| `patch` | Number representing patch semver value | +| `sha` | sha that a GitHub release was tagged at | +| `pr` | The PR number of an opened release (undefined if no release created) | + ## How release please works Release Please automates CHANGELOG generation, the creation of GitHub releases,