GitHub Issue Resource

Concourse resource for GitHub issues.

Note: Currently, only checking and using it for get steps is supported.

Source Configuration

• hostname: Required. The GitHub hostname to be used, for example github.com.

• token: Required. The GitHub access token to authenticate to the configured GitHub hostname.

• repository: Required. The GitHub repository to work with, for example homeport/github-issue-resource.

• labels: Optional List of labels to use in the issue list filter.

Example

Since it is a custom resource type, it has to be configured once in the pipeline configuration.

resource_types:
- name: github-issue-resource
  type: docker-image
  source:
   repository: ghcr.io/homeport/github-issue-resource
   tag: latest

One example would be to trigger a job, if a new issue was opened in a repository.

resources:
- name: repo-issue
  type: github-issue-resource
  check_every: 2h
  icon: alert-circle-outline
  source:
    hostname: github.com
    token: ((github-access-token))
    repository: homeport/github-issue-resource
    labels: ["foobar"]

jobs:
- name: some-job
  plan:
  - get: repo-issue
    trigger: true
  - task: some-task
    config:
      inputs:
      - name: repo-issue
      run:
        path: /bin/bash
        args:
        - -c
        - |
          #!/bin/bash
          ...

Behavior

check: Check for issues

Checks the currently open issues in the configured repository.

in: Get an issue

This is a no-op.

Parameters for in

There are no parameters.

out: No-op

This is a no-op.

Parameters for out

There are no parameters.