CommentCI

A tool to sent comments to Issues or Pull Requests in Github from CI tools.

---

Platforms

Supported platforms	Fully supported	In development
Github	✔
GitLab	✔
BitBucket		✔

Usage

Required environment variables:

• API_USER - User from which name will be sent comments.
• API_TOKEN - Personal Token for comment user.

Available parameters:

usage: CommentCI [-h|--help] -o|--owner "<value>" -r|--repository "<value>"
                 [-s|--single-comment "<value>"] [-c|--codify] [-f|--file
                 "<value>" [-f|--file "<value>" ...]] [-l|--file-comment
                 "<value>" [-l|--file-comment "<value>" ...]] -i|--issue-number
                 <integer> [-m|--multi-comment] -p|--platform (github|gitlab)
                 [-g|--target-type (issue|merge-request)]

                 Sent a comment to GitHub PR or Issue from your CI

Arguments:

  -h  --help            Print help information
  -o  --owner           Owner of the repository. User/Organisations.
  -r  --repository      Name of the repository.
  -s  --single-comment  Single comment string to sent to GitHub.
  -c  --codify          Put format to the Markdown code block.
  -f  --file            By repeating this flag you can specify multiple files
                        which content will be sent to comment.
  -l  --file-comment    By repeating this flag you can specify format for
                        provided files in according order.
  -i  --issue-number    Number(id) of the Issue/PR to sent a comment.
  -m  --multi-comment   Put each file into a separate comment in GitHub..
                        Default: false
  -p  --platform        Select platform where to send format
  -g  --target-type     Select type of comment target (GitLab only)

Usage examples:


Single comment:

API_USER=user API_TOKEN=xxx commentci -g github -o repo_owner -r repo_name -i 2 -s "Single comment"

Single file with a comment:

API_USER=user API_TOKEN=xxx commentci -g github -o repo_owner -r repo_name -i 2 -c -l "Comment to example file" -f ./example.txt

Multiple files with comments:

API_USER=user API_TOKEN=xxx commentci -g github -o repo_owner -r repo_name -i 2 -c -l "Comment to example file 1" -f ./example_1.txt -l "Comment to example file 2" -f ./example_2.txt