https://github.com/skyleaworlder/github-comment-buildkite-plugin

:speech_balloon: Post a comment to an Issue or PR on GitHub.
https://github.com/skyleaworlder/github-comment-buildkite-plugin

buildkite-plugin

Last synced: about 2 months ago
JSON representation

:speech_balloon: Post a comment to an Issue or PR on GitHub.

• Host: GitHub
• URL: https://github.com/skyleaworlder/github-comment-buildkite-plugin
• Owner: skyleaworlder
• License: mit
• Created: 2023-08-16T14:50:50.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-08-17T07:49:14.000Z (over 1 year ago)
• Last Synced: 2024-10-12T21:13:08.415Z (3 months ago)
• Topics: buildkite-plugin
• Language: Shell
• Homepage:
• Size: 3.91 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# github-comment-buildkite-plugin

:speech_balloon: Post a comment to an Issue or PR on GitHub.

## Usage

### 1. Properties

| Name | Description |

| :-: | :-: |

| repository | owner and repo name, e.g. FluxML/Flux.jl |

| issue_number | PR id or Issue id |

### 2. Necessary Resources

* You have to provide an artifact named "comment.txt", in the same build.

* You have to provide 3 environment variables so that this plugin is able to generate `Installation Access Token` via GitHub REST-ful APIs:

  * `APP_ID`: any GitHub App should own an "id", required to generate Installation Access Token.

  * `INSTALLATION_ID`: any App installed should have an "installation id", required to generate Installation Access Token.

  * `PEM_CONTENT_B64`: related to the **private key**, but encoded in base64, also required to generate Installation Access Token.

### 3. Example

```yaml

steps:

  - label: ":rocket: Test plugin"

    env:

      APP_ID: 123456

      INSTALLATION_ID: 12345678

      PEM_CONTENT_B64: "ABCDEFGHIJKLMNOPQRSTUVWXYZ="

    commands: |

      echo "Hi! I'm github-comment-buildkite-plugin created by skyleaworlder!" > comment.txt

      buildkite-agent artifact upload comment.txt

    plugins:

      - skyleaworlder/github-comment:

          repository: Eternal-Night-Archer/BenchmarkData

          issue_number: 2

```