Merge pull request #477 from peter-evans/dev

signoff

Author: peter-evans

.github/workflows/cpr-example-command.yml

@@ -18,6 +18,7 @@ jobs:
           commit-message: Update report
           committer: GitHub <[email protected]>
           author: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>
+          signoff: false
           title: '[Example] Update report'
           body: |
             Update report

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 protected]>`. Defaults to the GitHub Actions bot user. | `GitHub <[email protected]>` |
 | `author` | The author name and email address in the format `Display Name <[email protected]>`. 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. |
@@ -156,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.
 
@@ -180,6 +181,7 @@ jobs:
           commit-message: Update report
           committer: GitHub <[email protected]>
           author: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>
+          signoff: false
           branch: example-patches
           title: '[Example] Update report'
           body: |