minimize-comments

minimize-comments javascript action

This action minimizes all comments by the specified user which include the given string in the comment body. It can be used as part of a workflow where a bot emits comments on every PR push. This action should be run at the beginning of the workflow to minimize all previous comments so that only the latest comments remain visible.

Inputs

github-token

Required The GitHub API token to use.

by-author

Required The id of the comment author to match.

body-includes

Required Newline-separated list of strings that must be present in the body of the comment for it to be minimized. If at least one of the strings in the body is found the comment will be minimized.

Outputs

None

Example usage

uses: iStreamPlanet/github-actions/minimize-comments@main
with:
  github-token: ${{secrets.GITHUB_TOKEN}}
  by-author: github-actions
  body-includes: |
    terraform plan
    terraform validate

Development

To build the action for distribution run npm run build before committing your changes.