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: latestresources:
- 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 theadmin:repo_hookscope. 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]
pipeline: pipeline-name
pipeline_instance_vars: {
your_instance_var_name: value
}
payload_base_url: your-payload-base-url
payload_content_type: json
payload_secret: your-payload-secretorg: 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 thewebhook_tokenproperty of the resource your webhook points to.operation: Required.createto create a new webhook. Updates existing webhook if your configuration differs from remote.deleteto delete an existing webhook. Outputs current timestamp on non-existing webhooks.
events: Optional. An array of events which will trigger your webhook. Default:pushpipeline: Optional. Defaults to the name of the pipeline executing the taskpipeline_instance_vars: Optional. Instance vars to append to the webhook url. These help Concourse identify which instance pipeline it should invokepayload_base_url: Optional. The base URL to send the webhook payload to. Defaults to the external Concourse URL of the pipeline executing the task.payload_content_type: Optional. Default:jsonjsonto serialize payloads to JSON.formto serialize payloads to x-www-form-urlencoded.
payload_secret: Optional. Secret that is used as the key to generate delivery signature headers, if the destination requires it for delivery validation.
Include the github-webhook-resource in your pipeline.yml file
resource_types:
- name: github-webhook-resource
type: docker-image
source:
repository: homedepottech/github-webhook-resource
tag: latest Now when you set your pipeline, you can optionally include instance variables that will be picked up by the resource. Here is a sample script that sets the pipeline for you.
#!/bin/sh
fly -t {your team name} sp -c pipeline.yml -p {your pipeline name} --instance-var {you instance variables}
The Concourse entrypoints are in bin/check, bin/in, and bin/out.js. 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 testBefore 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-resourceresource_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.