Try to update earliest matching comment

[dkwon17]

Description

Signed-off-by: dkwon17 [email protected]

Context

In the case of https://github.com/eclipse-che/che-dashboard, where the GitHub action is added to the repository like so:

on:
  pull_request_target:
    types: [opened, synchronize]

jobs:
  add-link:
    runs-on: ubuntu-22.04
    steps:
      - name: Web IDE Pull Request Check
        id: try-in-web-ide
        uses: redhat-actions/try-in-web-ide@v1
        with:
          github_token: ${{ secrets.CHE_BOT_GITHUB_TOKEN }}

Whenever a pull request is made, and whenever a new commit has been made to the pull request branch, duplicate Click here to review and test in web IDE: comments are being made (for example see: eclipse-che/che-dashboard#826)

The GitHub action tries to prevent this issue by trying to detect if a comment has already been made, before it decides to make a new comment or not.

The reason why there are duplicate comments in the case of che-dashboard repo, is because the comments are being made by che-bot which is a regular user. Currently, GitHub action comments are not detected, unless they are made by a bot, see #29.

What does this PR do

This PR takes the simple stupid approach of just trying to edit the earliest match of the comment string if needed, regardless of if the comment author is a bot or not.

In most cases, the earliest comment which matches the comment string, would be the comment created using the GitHub action anyways.

Why not try to determine the author of the comment by checking the current github_token specified to the GH action?

The token may not have get-user permissions. For example, the secrets.GITHUB_TOKEN token (which is the default token for GH actions) does not have this permission.

Related Issue(s)

#31

Checklist

• This PR includes a documentation change
• This PR does not need a documentation change

---

• This PR includes test changes
• This PR's changes are already tested

---

• This change is not user-facing
• This change is a patch change
• This change is a minor change
• This change is a major (breaking) change

Changes made