Skip to content

Commit

Permalink
docs: clarifying releasable units and force-run label (#1570)
Browse files Browse the repository at this point in the history
* docs: clarifying releasable units and force-run label

* docs: adding explanation to other interfaces than GitHub Apps

Co-authored-by: Jeff Ching <[email protected]>

* Update README.md

Co-authored-by: Jeff Ching <[email protected]>
  • Loading branch information
suztomo and chingor13 authored Aug 11, 2022
1 parent 7c283ca commit d4b67f3
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,11 +115,18 @@ commit message instead of the merged commit message.
Release Please creates a release pull request after it notices the default branch
contains "releasable units" since the last release.
A releasable unit is a commit to the branch with one of the following
prefixes: "feat" and "fix". (A "chore" commit is not a releasable unit.)
prefixes: "feat", "fix", and "deps".
(A "chore" or "build" commit is not a releasable unit.)

Some languages have their specific releasable unit configuration. For example,
"docs" is a prefix for releasable units in Java and Python.

If you think Release Please missed to create a release PR after a pull request
with with releasable unit has been merged, please re-run `release-please`. If you are using
the GitHub application, add `release-please:force-run` label to the merged pull request. If
you are using the action, look for the failed invocation and retry the workflow run.
Release Please will process the pull request immediately to find releasable units.

## Strategy (Language) types supported

Release Please automates releases for the following flavors of repositories:
Expand Down

0 comments on commit d4b67f3

Please sign in to comment.