joshdk / hub-comment

📝 Automated GitHub pull request comments from CI

Hub-Comment

📝 Automate GitHub pull request comments in CI

Installing

From source

You can install a development version of this tool by running:

$ go get -u github.com/joshdk/hub-comment

Precompiled binary

Alternatively, you can download a precompiled release binary by running:

$ wget -q https://github.com/joshdk/hub-comment/releases/download/0.1.0/hub-comment_linux_amd64
$ sudo install hub-comment_linux_amd64 /usr/bin/hub-comment

Usage

Environment Setup

Since hub-comment communicates with the GitHub API, you must first create and export an API token into the working environment.

$ export GITHUB_TOKEN='2b6c...f4bd'

Comment Template

You can write a comment template file, using the same syntax used for Go templates. For example, you could save the following as hello-template.txt:

🤖 Hello from CI!

Build #{{.Env.CIRCLE_BUILD_NUM}} was run successfully.

Running

$ hub-comment -template-file hello-template.txt
Posting new comment as Josh Komoroske (joshdk) on joshdk/hub-comment#123:

→ 🤖 Hello from CI!
→
→ Build #123 was run successfully.

To view comment visit:
→ https://github.com/joshdk/hub-comment/issues/123#issuecomment-421483151

License

This code is distributed under the MIT License, see LICENSE.txt for more information.

hub-comment's Issues

Test issue

Add support for GitHub Action environment

https://developer.github.com/actions/creating-github-actions/accessing-the-runtime-environment/#environment-variables

Add a comment delete option

If you want to have a pair of status messages (test failed, and eventually the same test passes) maybe the last one should delete the comment (only post a comment if you have something interesting to say).

Add dry run functionality

Preview templated text without posting.

Automated file uploading and attaching

It would be nice to be able to upload and attach build artifacts to comments (logs, tarballs, screenshots, etc).

While it's possible to upload files using a browser, there currently isn't a way to do this via the official API...

Add support for reading GitHub labels

Allow specifying different types of comments

Enable posting multiple distinct types of comments (build status, artifact links) that can co-exist without clobbering (editing) one-another.