https://github.com/homeport/github-issue-resource
Concourse resource for GitHub issues
https://github.com/homeport/github-issue-resource
concourse-resource github-issues
Last synced: 8 months ago
JSON representation
Concourse resource for GitHub issues
- Host: GitHub
- URL: https://github.com/homeport/github-issue-resource
- Owner: homeport
- License: mit
- Created: 2022-11-07T15:02:47.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-27T00:21:16.000Z (over 1 year ago)
- Last Synced: 2025-01-27T01:22:57.752Z (over 1 year ago)
- Topics: concourse-resource, github-issues
- Language: Shell
- Homepage:
- Size: 19.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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.
```yaml
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.
``` yaml
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.