Chapter 6. Managing pipeline runs

• {{repo_owner}}: The repository owner.
• {{repo_name}}: The repository name.
• {{repo_url}}: The repository full URL.
• {{revision}}: Full SHA revision of a commit.
• {{sender}}: The username or account id of the sender of the commit.
• {{source_branch}}: The branch name where the event originated.
• {{target_branch}}: The branch name that the event targets. For push events, it’s the same as the source_branch.
• {{pull_request_number}}: The pull or merge request number, defined only for a pull_request event type.
• {{git_auth_secret}}: The secret name that is generated automatically with Git provider’s token for checking out private repos.

• The author is the owner of the repository.
• The author is a collaborator on the repository.
• The author is a public member on the organization of the repository.
• The comment author is listed in the approvers or reviewers section of the OWNERS file in the root of the repository, as defined in the Kubernetes documentation. Pipelines as Code supports the specification for the OWNERS and OWNERS_ALIASES files. If the OWNERS file includes a filters section, Pipelines as Code matches approvers and reviewers only against the .* filter.

• To match a pull_request event targeting the main branch and coming from the wip branch:

  apiVersion: tekton.dev/v1
  kind: PipelineRun
  metadata:
    name: pipeline-advanced-pr
  annotations:
    pipelinesascode.tekton.dev/on-cel-expression: |
      event == "pull_request" && target_branch == "main" && source_branch == "wip"
  ...

• To run a pipeline only if a path has changed, you can use the .pathChanged suffix function with a glob pattern:

  apiVersion: tekton.dev/v1
  kind: PipelineRun
  metadata:
    name: pipeline-advanced-pr-pathchanged
  annotations:
    pipelinesascode.tekton.dev/on-cel-expression: |
      event == "pull_request" && "docs/\*.md".pathChanged() 1
  # ...

  1

  Matches all markdown files in the docs directory.

• To match all pull requests starting with the title [DOWNSTREAM]:

  apiVersion: tekton.dev/v1
  kind: PipelineRun
  metadata:
    name: pipeline-advanced-pr-downstream
  annotations:
    pipelinesascode.tekton.dev/on-cel-expression: |
      event == "pull_request && event_title.startsWith("[DOWNSTREAM]")
  # ...

• To run a pipeline on a pull_request event, but skip the experimental branch:

  apiVersion: tekton.dev/v1
  kind: PipelineRun
  metadata:
    name: pipeline-advanced-pr-not-experimental
  annotations:
    pipelinesascode.tekton.dev/on-cel-expression: |
      event == "pull_request" && target_branch != experimental"
  # ...

• event: A push or pull_request event.
• target_branch: The target branch.
• source_branch: The branch of origin of a pull_request event. For push events, it is same as the target_branch.
• event_title: Matches the title of the event, such as the commit title for a push event, and the title of a pull or merge request for a pull_request event. Currently, only GitHub, Gitlab, and Bitbucket Cloud are the supported providers.
• .pathChanged: A suffix function to a string. The string can be a glob of a path to check if the path has changed. Currently, only GitHub and Gitlab are supported as providers.

• The pull request is targeting the main branch.
• The author of the pull request is superuser.
• The action is synchronize; this action triggers when an update occurs on a pull request.

Additional resources

• CEL language specification

• The author is the owner of the repository.
• The author is a collaborator on the repository.
• The author is a public member on the organization of the repository.
• The pull request author is listed in the approvers or reviewers section of the OWNERS file in the root of the repository, as defined in the Kubernetes documentation. Pipelines as Code supports the specification for the OWNERS and OWNERS_ALIASES files. If the OWNERS file includes a filters section, Pipelines as Code matches approvers and reviewers only against the .* filter.

• To follow the execution of the last pipeline run, use the following example:

  $ tkn pac logs -n <my-pipeline-ci> -L 1

  1

  my-pipeline-ci is the namespace for the Repository CRD.

• To follow the execution of any pipeline run interactively, use the following example:

  $ tkn pac logs -n <my-pipeline-ci> 1

  1

  my-pipeline-ci is the namespace for the Repository CRD. If you need to view a pipeline run other than the last one, you can use the tkn pac logs command to select a PipelineRun attached to the repository:

• The /test and /retest comment restarts all pipeline runs.
• The /test <pipeline_run_name> and /retest <pipeline_run_name> comment starts or restarts a specific pipeline run. You can use this command to start any Pipelines as Code pipeline run on the repository, whether or not it was triggered by an event for this pipeline run.

• The /cancel comment cancels all pipeline runs.
• The /cancel <pipeline_run_name> comment cancels a specific pipeline run.

• The author is the owner of the repository.
• The author is a collaborator on the repository.
• The author is a public member on the organization of the repository.
• The comment author is listed in the approvers or reviewers section of the OWNERS file in the root of the repository, as defined in the Kubernetes documentation. Pipelines as Code supports the specification for the OWNERS and OWNERS_ALIASES files. If the OWNERS file includes a filters section, Pipelines as Code matches approvers and reviewers only against the .* filter.

Procedure

• If you target a pull request and you use the GitHub App, go to the Checks tab and click Re-run all checks.

• If you target a pull or merge request, use the comments inside your pull request:

  Example comment that cancels all pipeline runs

  This is a comment inside a pull request.
  /cancel

• If you target a push request, include the comments within your commit messages.

  Note

  This feature is supported for the GitHub provider only.

  1. Go to your GitHub repository.
  2. Click the Commits section.
  3. Click the commit where you want to restart a pipeline run.

  4. Click on the line number where you want to add a comment.

     Example comment that starts or restarts a specific pipeline run

     This is a comment inside a commit.
     /retest example_pipeline_run

     Note

     If you run a command on a commit that exists in multiple branches within a push request, the branch with the latest commit is used.

     This results in two situations:

     • If you run a command on a commit without any argument, such as /test, the test is automatically performed on the main branch.
     • If you include a branch specification, such as /test branch:user-branch, the test is performed on the commit where the comment is located with the context of the user-branch branch.

Additional resources

• An example task to send Slack messages on success or failure
• An example of a pipeline run with finally tasks triggered on push events

Additional resources

• An example of the git-clone task used for cloning private repositories

• The incoming webhook URL that Pipelines as Code matches.

• The Git provider and the user token. Currently, Pipelines as Code supports github, gitlab, and bitbucket-cloud.

  Note

  When using incoming webhook URLs in the context of GitHub app, you must specify the token.

• The target branches and a secret for the incoming webhook URL.