feat: add DeNA/unity-meta-check/unity-meta-check-github-pr-comment

[ponkio-o]

DeNA/unity-meta-check/unity-meta-check-github-pr-comment: Reporter for GitHub comments of GitHub issues or pull requests. It need a result of unity-meta-check from stdin.

Check List

• Read CONTRIBUTING.md
  • Read OSS Contribution Guide
• All commits are signed
  • This repository enables Require signed commits, so all commits must be signed
• Avoid force push
• Do only one thing in one Pull Request

How to confirm if this package works well

Reviewers aren't necessarily familiar with this package, so please describe how to confirm if this package works well.
Please confirm if this package works well yourself as much as possible.

Command and output

root@927907d6c78d:/workspace# unity-meta-check-github-pr-comment --help
usage: unity-meta-check-github-pr-comment [<options>]

Post a comment for the result from unity-meta-check via STDIN to GitHub Pull Request.

OPTIONS
  -api-endpoint string
        GitHub API endpoint URL (like https://api.github.com or https://github.example.com/api/v3) (default "https://api.github.com")
  -debug
        set log level to DEBUG (default INFO)
  -lang string
        language code (available: en, ja) (default "en")
  -no-send-success
        do not send a comment if no missing/dangling .meta found
  -owner string
        owner of the GitHub repository
  -pull int
        pull request number
  -repo string
        name of the GitHub repository
  -silent
        set log level to WARN (default INFO)
  -template-file string
        custom template file
  -version
        print version

ENVIRONMENT
  GITHUB_TOKEN
        GitHub API token. The scope can be empty if your repository is public. Otherwise, the scope should contain "repo"

EXAMPLE USAGES
  $ export GITHUB_TOKEN="********"
  $ unity-meta-check <options> | unity-meta-check-github-pr-comment \
      -api-endpoint https://api.github.com \
      -owner example-org \
      -repo my-repo \
      -pull "$CIRCLE_PR_NUMBER"  # This is for CircleCI

  $ export GITHUB_TOKEN="********"  # This should be set via credentials().
  $ unity-meta-check <options> | unity-meta-check-github-pr-comment \
      -api-endpoint https://github.example.com/api/v3 \
      -owner example-org \
      -repo my-repo \
      -pull "$ghprbPullId"  # This is for Jenkins with GitHub PullRequest Builder plugin

  $ GITHUB_TOKEN="********" unity-meta-check <options> | unity-meta-check-junit path/to/unity-meta-check-result.xml | unity-meta-check-github-pr-comment <options> | <other-unity-meta-check-tool>

  $ export GITHUB_TOKEN="********"  # This should be set via credentials().
  $ unity-meta-check <options> | unity-meta-check-github-pr-comment \
      -api-endpoint https://github.example.com/api/v3 \
      -owner example-org \
      -repo my-repo \
      -pull "$ghprbPullId" \
      -template-file path/to/template.json  # template file can be used for localization for GitHub comments.

TEMPLATE FILE FORMAT EXAMPLE
  If a template file is like:

  {
    "success": "No missing/dangling .meta found. Perfect!",
    "failure": "Some missing or dangling .meta found. Fix commits are needed.",
    "header_status": "Status",
    "header_file_path": "File",
    "status_missing": "Not committed",
    "status_dangling": "Not removed"
  }

  then the output become:

  No missing/dangling .meta found. Perfect!

  or:

  Some missing or dangling .meta found. Fix commits are needed.

  | Status | File |
  |:--|:--|
  | Not committed | `path/to/missing.meta` |
  | Not removed | `path/to/dangling.meta` |

If files such as configuration file are needed, please share them.

Reference

• https://github.com/DeNA/unity-meta-check/blob/master/README.md

[suzuki-shunsuke]

Thank you!

[suzuki-shunsuke]

Same with #22862 (review)

[ponkio-o]

Sorry. I did not understand such a policy and will correct everything PRs.

[suzuki-shunsuke]

Sorry. I did not understand such a policy and will correct everything PRs.

I'm sorry I didn't explain about this.
I should write the document about it in the style guide. https://aquaproj.github.io/docs/develop-registry/registry-style-guide
I didn't write the document because it's hard to explain this in English to me. 😅

[suzuki-shunsuke]

BTW, all pull requests would conflict everytime these pull requests are merged because these package names are consecutive.
In that case, I always resolve the conflict by the following way.

1. Copy registry.yaml to registry.yaml.bak in advance

cp registry.yaml registry.yaml.bak

2. Checkout the pull request branch

gh pr checkout 22863

3. Merge main branch, then conflict would occur

git fetch origin main
git merge origin/main

4. Copy registry.yaml.bak to registry.yaml

cp registry.yaml.bak registry.yaml

5. Run cmdx gr, then conflict would be resolved

cmdx gr

6. Create a commit and push it to the remote branch

[suzuki-shunsuke]

v4.180.0 is out 🎉
https://github.com/aquaproj/aqua-registry/releases/tag/v4.180.0