Designed to be an entrypoint task for GitHub webhook triggers based on PR comments. pr-comment-filter will check the comment text for recognised triggers (e.g. /run my-pipeline) and generate individual PipelineRun resources for each.
The generated PipelineRun will have details about the PR passed through as params as well as any arguments added to the trigger comment.
Details about files updated in the PR will also be included as parameters on the PipelineRun with the following params being defined with a comma separated string value:
PR_FILES- Includes all files contained in the PRPR_FILES_ADDED- Includes all new filesPR_FILES_CHANGED- Includes all modified/changed/renamed filesPR_FILES_REMOVED- Includes all files removed in the PR
All triggers must follow the following format:
/run ${PIPELINE_NAME} [KEY=val ...]
Examples:
/run build-and-publish
/run test-cluster-create PRIVATE_NETWORK=true
/run test-cluster-create PREVIOUS_VERSION=1.2.6
/run test-cluster-upgrade PRIVATE_NETWORK=false PREVIOUS_VERSION=1.2.6
/run hold wait-for-tests
/run help NAMESPACE=foo-bar test-cluster-create
Some notes:
- Multiple triggers can be defined in a single comment but must each be on their own line
- Triggers must start the line with
/runand cannot be placed mid-sentance - Arguments are optional and in the format of either:
KEY=valuewhere the key must be all uppercase and is used as the key/val pair of environment variables- space seperated words - these are treated as "positional arguments" and added as the
POS_ARGSenv var with the values comma seperated
- Multiple arguments can be provided as long as they all appear on the same line as the trigger
- Argument values with spaces in them is not currently supported
- A Pipeline from a specific namespace can be run by specifying a
NAMESPACE=xxxargument along with the/runtrigger line - If a user provided namespace isn't provided the pipeline will first be looked for in a namespace matching the repo name and if not found then default back to the
tekton-pipelinesnamespace.