Skip to content

action_ansible docs build comment

BS[bot] edited this page Jan 16, 2022 · 3 revisions

ansible-docs-build-comment

Post, edit, or remove a PR comment.

Handles the docs build PR comment operations.

Inputs

Name (✅required) Default Description
pr-number ${{ github.event.number }} The PR in question.
body-includes Text to search for in comments to identify an existing comment to be edited.
body The body of the comment to post. Required when action == 'update' or PR is not closed.
on-merged-body A comment body to use when a PR is merged.
on-closed-body A comment body to use when a PR is closed without being merged.
on-merged-action update Action to take when a PR is merged.
on-closed-action update Action to take when a PR is closed without being merged.
reactions A comma separated list of reactions to add to the comment. Can be any of:
+1, -1, laugh, confused, heart, hooray, rocket, eyes
action Unconditional action to take. 'update' means create or update a comment. 'remove' means to remove any existing comment.
Takes precedence over conditional actions.

Outputs

Name Description
comment-id The ID of the comment.