Skip to content

GitHub PR comment post tool from CI environments

Notifications You must be signed in to change notification settings

at-wat/gh-pr-comment

Folders and files

NameName
Last commit message
Last commit date
Apr 7, 2022
May 1, 2023
May 1, 2023
Oct 7, 2020
Feb 4, 2022
Apr 29, 2021
Jan 4, 2023
Apr 7, 2022
Apr 29, 2021
Nov 4, 2020
May 1, 2023
May 1, 2023
Jan 29, 2021
Oct 21, 2021

Repository files navigation

gh-pr-comment

Command line tool for GitHub pull-request (issue) comment.

Usage

$ gh-pr-comment title comment

Install

GitHub Actions

https://github.com/at-wat/setup-gh-pr-comment

      - uses: at-wat/setup-gh-pr-comment@v0
      ...
      - run: gh-pr-comment "title" "message"
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Download compiled binary

# Install latest version under ~/.local/bin
$ curl -sL https://raw.githubusercontent.com/at-wat/gh-pr-comment/master/install.sh | sh -s

# Install latest version under /path/to/bin
$ curl -sL https://raw.githubusercontent.com/at-wat/gh-pr-comment/master/install.sh \
  | sh -s latest /path/to/bin

# Install specific version under /usr/local/bin
$ curl -sL https://raw.githubusercontent.com/at-wat/gh-pr-comment/master/install.sh \
  | sh -s v0.5.0 /path/to/bin

Required environment variables

To run gh-pr-comment inside docker container, required environemnt variables can be automatically specified by the following script.

$ docker run [your options...] \
    $(bash <(curl -s https://raw.githubusercontent.com/at-wat/gh-pr-comment/master/env.sh)) \
    image commands...

env.sh is also bundled as gh-pr-comment-env.sh in release archives.

General

  • GITHUB_TOKEN: token with comment write permission

Optional

  • GITHUB_API_URL_BASE: specify GitHub Enterprise or any custom endpoint URL

Travis-CI

  • TRAVIS: true
  • TRAVIS_PULL_REQUEST_SLUG: owner/repos
  • TRAVIS_PULL_REQUEST: pull request number

Security

If your environment handles sensitive information, it is recommended to download install.sh and env.sh from https://github.com/at-wat/gh-pr-comment/releases and verify the signature using GPG. My public key is available at https://github.com/at-wat.gpg and SKS keyserver pool.

(fingerprint: 358B DF63 B4AE D76A 871A E62E 1BF1 686B 468C 35B2)

About

GitHub PR comment post tool from CI environments

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •