| token | Personal access token (PAT) used when interacting with Git and GitHub.
We recommend using a service account with the least permissions necessary. Also when generating a new PAT, select the least scopes necessary.
[Learn more about creating and using encrypted secrets](https://help.github.com/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)
| yes | — |
| path | A path or wildcard pattern specifying files to transform. Multiple paths can be specified using literal styled YAML.
| no | LICENSE |
| transform | A regular expression (JavaScript flavor) describing the license transform. The expression must have the following properties:
- A capturing group named "from", encapsulating the first year of license validity
- Written to support the RegExp flags "gmi" ("global", "multiline" and "ignore case")
The expression will be used by String.prototype.replace() to apply the transformation.
| no | — |
| branchName | The branch name. Supports substituting variable {{currentYear}}. | no | license/copyright-to-{{currentYear}} |
| commitTitle | The git commit title. Supports substituting variable {{currentYear}}. | no | docs(license): update copyright year(s) |
| commitBody | The git commit body that will be appended to commit title, separated by two line returns. Supports substituting variable {{currentYear}}.
| no | "" |
| commitAuthorName | The git author name, used when committing changes to the repository. | no | github-actions |
| commitAuthorEmail | The git author e-mail, used when committing changes to the repository. | no | github-actions@github.com |
| gpgPrivateKey | The GPG private key, used in combination with gpgPassphrase when signing commits. Private keys protected by a passphrase are supported while private keys without a passphrase are unsupported.
| no | "" |
| gpgPassphrase | The GPG passphrase, used in combination with gpgPrivateKey when signing commits. | no | "" |
| prTitle | The title of the new pull request. Supports substituting variable {{currentYear}}. | no | Update license copyright year(s) |
| prBody | The contents of the pull request. Supports substituting variable {{currentYear}}. | no | "" |
| assignees | Comma-separated list with usernames of people to assign when pull request is created.
| no | "" |
| labels | Comma-separated list of labels to add when pull request is created. | no | "" |