By default, Concourse will check your resources once per minute to see if they have updated. In order to reduce excessive checks, you must configure webhooks to trigger Concourse externally. This resource automatically configures your GitHub respoitories to send webhooks to your Concourse pipeline the instant a change happens.

resource_types:
- name: github-webhook-resource
  type: docker-image
  source:
    repository: homedepottech/github-webhook-resource
    tag: latest

resources:
- name: github-webhook
  type: github-webhook-resource
  source:
    github_api: https://github.example.com/api
    github_token: ((github-token))

• github_api: Required. The Github API URL for your repo.
• github_token: Required. A Github token with the admin:repo_hook scope. Additionally, the token's account must be an administrator of your repo to manage the repo's webhooks.

Create or delete a webhook using the configured parameters.

- put: create-webhook
  resource: github-webhook
  params:
    org: github-org-name
    repo: github-repo-name
    resource_name: your-resource-name
    webhook_token: your-token
    operation: create
    events: [push, pull_request]

• org: Required. Your github organization.
• repo: Required. Your github repository.
• resource_name: Required. Name of the resource to be associated with your webhook.
• webhook_token: Required. Arbitrary string to identify your webhook. Must match the webhook_token property of the resource your webhook points to.
• operation: Required.
  • create to create a new webhook. Updates existing webhook if your configuration differs from remote.
  • delete to delete an existing webhook. Outputs current timestamp on non-existing webhooks.
• events: Optional. An array of events which will trigger your webhook. Default: push

• Node.js
• Docker

The Concourse entrypoints are in bin/check, bin/in, and bin/out. You can add functionality to these files directly, or you can require additional supporing files.

See the Reference section for some helpful information related to this project's implementation.

npm install
npm test

Before submitting your changes for review, ensure all tests are passing.

docker build -t github-webhook-resource .

To use the newly built image, push it to a Docker repository which your Concourse pipeline can access and configure your pipeline to use it:

docker tag github-webhook-resource example.com/github-webhook-resource
docker push example.com/github-webhook-resource

resource_types:
- name: github-webhook-resource
  type: docker-image
  source:
    repository: example.com/github-webhook-resource
    tag: latest

resources:
- name: github-webhook
  type: github-webhook-resource
  ...

Please read the CONTRIBUTING.md file to learn the process for submitting changes to this repo.

This project is licensed under Apache 2.0 - see the LICENSE file for details.

• Implementing a Concourse Resource
• What is a Webhook?
• GitHub's Webhook REST API
• Concourse Community Resources