You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The users of the action and reusable workflow may wish to attribute commits for the rendered documentation to a specific
user. This can now be done via the newly added `committer-name` and `committer-email` action inputs.
The inputs are optional, using the GitHub Actions bot account as the default author, as was done before the addition of
the inputs.
Copy file name to clipboardExpand all lines: README.md
+2
Original file line number
Diff line number
Diff line change
@@ -80,6 +80,8 @@ The workflow has a couple of inputs that allows to configure the behaviour:
80
80
- `fail-on-warnings`The command prints documentation issues such as missing documentation. This option makes the action fail when such issues are found. This allows to achieve 100% documentation coverage.
81
81
- `commit`Defines whether the rendered markdown files should be committed to the repository automatically.
82
82
- `commit-message`Defines the commit message to be used when `commit` is set to true.
83
+
- `committer-name`Username to use as the author of the commit. Defaults to "github-actions[bot]".
84
+
- `committer-email`Email address to use as the author of the commit. Defaults to the email for "github-actions[bot]".
83
85
- `debug`Enable this option to get additional output from the tool. This allows to debug in case you get unexpected output from the command.
0 commit comments