kanga333 / comment-hider

Github Action to hide comments made by Github Action

Github Action to hide Bot comments

Comment-hider action automatically hides bot comments posted to PR.

• Automatically hide certain users' comments posted to PR. (The default is github-actions[bot].)

Sample Workflows

Posting the results of CI/CD in the PR comments is a common practice. Comment-hider action is useful for hiding outdated posts in these cases.

on:
  pull_request:
steps:
- uses: actions/checkout@v2

- uses: kanga333/comment-hider@master
  name: Hide bot comments
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    # See action.yml for other options you can specify

- id: cicd
  run: |
    echo "Run some kind of CI/CD."

- uses: actions/[email protected]
  with:
    github-token: ${{ secrets.GITHUB_TOKEN }}
    script: |
      const output = `${{ steps.cicd.outputs.stdout }}`;
      github.issues.createComment({
        issue_number: context.issue.number,
        owner: context.repo.owner,
        repo: context.repo.repo,
        body: output
      })

comment-hider's Issues

Hide all comments with exception to the last

Hi 👋

I really like your action and I'd like to contribute a small change.
Currently this action hide all comments which is helpful but I think it would be great if the last comment was left visible. I think this will make most people's desires (usually you want to see the last annoying "your commit fails in CI" message)

If this is a feature you are interested in I'd love to open a PR with a possible implementation!

Update to Node16

https://github.blog/changelog/2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12/

Iterate over all comments

Thank you for this action!

Currently, only the first 30 comments can be hidden.
When the comments are queried here

comment-hider/src/client.ts

Line 38 in c12bb20

const resp = await this.octokit.rest.issues.listComments({

the default of 30 is used (see docs).

To get all comments, we would have to get the comments repeatedly, i.e. per_page=100 and then query consecutive pages until we are done.

Setting up an integration test

GITHUB_TOKEN does not allow PRs from forked repositories to post comments, so the integration test does not work.

See also:
https://docs.github.com/en/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token

Instead, set a personal token to enable integration to work.

possible values of hide_reason not documented

Would be nice if the comment in action.yml linked to https://docs.github.com/en/graphql/reference/enums#reportedcontentclassifiers

Bad error message when issue number is wrong

For anyone searching it, the error message for not finding issue number is Error: Not Found with no other details. That could be improved too.

Originally posted by @Akuli in #26 (comment)

Update to Node 20

Github is showing warning about this action:

Warning

Node.js 16 actions are deprecated. Please update the following actions to use Node.js 20: kanga333/[email protected]. For more information see: https://github.blog/changelog/2023-09-22-github-actions-transitioning-from-node-16-to-node-20/.

Would you please be able to update this action?

"on: workflow_run" support: providing issue number manually

I wanted to use this action with on: workflow_run, like this: https://securitylab.github.com/research/github-actions-preventing-pwn-requests/

But then it couldn't access the issue number (actually, pull request number), which must be provided as an explicit input to each actions when using on: workflow_run.

I started working on a PR that adds an issue_number input, so that you could do something like this, assuming the issue number is stored in issue_number.txt:

- name: Read PR number
  id: issue-number
  run: echo "::set-output name=issueNumber::$(cat issue_number.txt)"
- uses: kanga333/comment-hider@...  # version tag or full commit hash
  name: Hide old comments
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    issue_number: ${{ steps.issue-number.outputs.issueNumber }}

The problem is that it takes two steps to first make the issue number available in ${{ ... }} syntax, and then to call the comment hider. Alternatively, the comment hider could read the issue number from a file:

- uses: kanga333/comment-hider@...  # version tag or full commit hash
  name: Hide old comments
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    issue_number_file: issue_number.txt

Which way is better?