From 64c8d492d5493036dc0a6290fdc29b65d82512c7 Mon Sep 17 00:00:00 2001
From: Peter Evans <peter-evans@users.noreply.github.com>
Date: Fri, 31 Jul 2020 16:59:26 +0900
Subject: [PATCH] Update documentation
---
.github/workflows/cpr-example-command.yml | 1 +
README.md | 5 +++--
2 files changed, 4 insertions(+), 2 deletions(-)
diff --git a/.github/workflows/cpr-example-command.yml b/.github/workflows/cpr-example-command.yml
index 00d793e..a545dfc 100644
--- a/.github/workflows/cpr-example-command.yml
+++ b/.github/workflows/cpr-example-command.yml
@@ -18,6 +18,7 @@ jobs:
commit-message: Update report
committer: GitHub <noreply@github.com>
author: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>
+ signoff: false
title: '[Example] Update report'
body: |
Update report
diff --git a/README.md b/README.md
index 2106f3d..d916ac1 100644
--- a/README.md
+++ b/README.md
@@ -45,6 +45,7 @@ All inputs are **optional**. If not set, sensible defaults will be used.
| `commit-message` | The message to use when committing changes. | `[create-pull-request] automated change` |
| `committer` | The committer name and email address in the format `Display Name <email@address.com>`. Defaults to the GitHub Actions bot user. | `GitHub <noreply@github.com>` |
| `author` | The author name and email address in the format `Display Name <email@address.com>`. Defaults to the user who triggered the workflow run. | `${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>` |
+| `signoff` | Add `Signed-off-by` line by the committer at the end of the commit log message. | `false` |
| `branch` | The pull request branch name. | `create-pull-request/patch` |
| `branch-suffix` | The branch suffix type when using the alternative branching strategy. Valid values are `random`, `timestamp` and `short-commit-hash`. See [Alternative strategy](#alternative-strategy---always-create-a-new-pull-request-branch) for details. | |
| `base` | Sets the pull request base branch. | Defaults to the branch checked out in the workflow. |
@@ -57,7 +58,6 @@ All inputs are **optional**. If not set, sensible defaults will be used.
| `team-reviewers` | A comma or newline separated list of GitHub teams to request a review from. Note that a `repo` scoped [PAT](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) may be required. See [this issue](https://github.com/peter-evans/create-pull-request/issues/155). | |
| `milestone` | The number of the milestone to associate this pull request with. | |
| `draft` | Create a [draft pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests). | `false` |
-| `signoff` | Add Signed-off-by to commit message | `false` |
### Action outputs
@@ -157,7 +157,7 @@ To create a project card for the pull request, pass the `pull-request-number` st
## Reference Example
-The following workflow is a reference example that sets all the main inputs.
+The following workflow is a reference example that sets many of the main inputs.
See [examples](docs/examples.md) for more realistic use cases.
@@ -181,6 +181,7 @@ jobs:
commit-message: Update report
committer: GitHub <noreply@github.com>
author: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>
+ signoff: false
branch: example-patches
title: '[Example] Update report'
body: |