Skip to content

Latest commit

 

History

History

0.2

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
tests
tests
 
 
README.md
README.md
 
 
github-add-comment.yaml
github-add-comment.yaml
 
 

README.md

Add a comment to an issue or a pull request

The github-add-comment task let you add a comment to a pull request or an issue.

Install the Task

kubectl apply -f https://api.hub.tekton.dev/v1/resource/tekton/task/github-add-comment/0.2/raw

Secrets

This Task requires access to a GitHub token set via a Kubernetes Secret. By default, the name of this Secret should be github and the secret key should be token, but you can configure this via the GITHUB_TOKEN_SECRET_NAME and GITHUB_TOKEN_SECRET_KEY parameters described below.

To create such a Secret via kubectl:

kubectl create secret generic github --from-literal token="MY_TOKEN"

Check this to get personal access token for Github.

See GitHub's documentation on Understanding scopes for OAuth Apps to figure out what scopes you need to give to this token to add comment to an issue or a pull request.

Parameters

  • GITHUB_HOST_URL:: The GitHub host domain (default: api.github.com)
  • API_PATH_PREFIX:: The GitHub Enterprise has a prefix for the API path. e.g: /api/v3
  • REQUEST_URL:: The GitHub pull request or issue url, e.g: https://github.com/tektoncd/catalog/issues/46
  • COMMENT:: The actual comment to add e.g: don't forget to eat your vegetables before commiting..
  • GITHUB_TOKEN_SECRET_NAME: The name of the Kubernetes Secret that contains the GitHub token. (default: github).
  • GITHUB_TOKEN_SECRET_KEY: The key within the Kubernetes Secret that contains the GitHub token. (default: token).

Platforms

The Task can be run on linux/amd64 platform.

Usage

This TaskRun add a comment to an issue.

---
apiVersion: tekton.dev/v1beta1
kind: TaskRun
metadata:
  labels:
    tekton.dev/task: github-add-comment
  name: github-add-comment-to-pr-22
spec:
  taskRef:
    kind: Task
    name: github-add-comment
  params:
    - name: REQUEST_URL
      value: https://github.com/chmouel/scratchpad/pull/46
    - name: COMMENT
      value: |
          The cat went here and there
          And the moon spun round like a top,
          And the nearest kin of the moon,
          The creeping cat, looked up.
          Black Minnaloushe stared at the moon,
          For, wander and wail as he would,
          The pure cold light in the sky
          Troubled his animal blood.