The following pipeline values are now officially documented and supported.
Unless otherwise noted in documentation, all values listed below are available for GitHub App pipelines only.
Pipeline and project information
These values are available across all VCS integrations.
| Value | Description |
|---|---|
pipeline.definition.id |
The unique ID of the pipeline definition. |
pipeline.project.slug |
The slug of the project the pipeline definition belongs to. |
pipeline.name |
The name of the pipeline definition. |
pipeline.integration_source |
The pipeline type based on the VCS integration used. Possible values: github_app, github, bitbucket, bitbucket_dc, gitlab. |
Trigger information
| Value | Description |
|---|---|
pipeline.trigger.id |
The unique ID of the trigger that initiated the pipeline. |
pipeline.trigger.type |
The type of trigger that initiated the pipeline. Possible values: github_app, bitbucket_dc, schedule, webhook, api. |
Checkout and repository information
| Value | Description |
|---|---|
pipeline.git.repo_url |
The URL of the repository. |
pipeline.git.repo_owner |
The VCS username of the repository owner. |
pipeline.git.repo_name |
The name of the repository, without the owner prefix. |
pipeline.git.repo_id |
The unique identifier of the repository. |
pipeline.git.commit.url |
The URL of the checkout commit. |
pipeline.git.commit.subject |
The subject line of the checkout commit message. |
pipeline.git.commit.body |
The body of the checkout commit message. |
pipeline.git.commit.author_login |
The VCS username of the author of the checkout commit. |
Configuration source
These values describe where CircleCI fetched the configuration file from. They are available for GitHub App pipelines where the configuration file can be stored in a separate repository from the code being built.
| Value | Description |
|---|---|
pipeline.config.file_path |
The file path to the CircleCI configuration file. |
pipeline.config.ref |
The full Git ref used to fetch the configuration file. |
pipeline.config.sha |
The SHA of the commit used to fetch the configuration file. |
pipeline.config.repository.name |
The name of the repository containing the configuration file, in owner/repo-name format. |
pipeline.config.repository.url |
The URL of the repository containing the configuration file. |
GitHub event details
Push events
| Value | Description |
|---|---|
pipeline.event.github.ref |
The full Git ref that was pushed. |
pipeline.event.github.after |
The SHA of the most recent commit on the branch after the push. |
pipeline.event.github.head_commit.url |
The URL of the most recent commit on the branch. |
Pull request events
| Value | Description |
|---|---|
pipeline.event.github.pull_request.base.sha |
The SHA of the base branch of the pull request. |
pipeline.event.github.pull_request.head.sha |
The SHA of the head branch of the pull request. |
pipeline.event.github.pull_request.url |
The URL of the pull request. |
pipeline.event.github.label.name |
The name of the label applied to the pull request. Only populated for pull request events with the labeled action. |
Sender
| Value | Description |
|---|---|
pipeline.event.github.sender.login |
The VCS username of the user who triggered the event. |
pipeline.event.github.sender.avatar_url |
The avatar URL of the user who triggered the event. |
Repository
| Value | Description |
|---|---|
pipeline.event.github.repository.name |
The name of the repository that triggered the event, without the owner prefix. |
pipeline.event.github.repository.owner.login |
The VCS username of the repository owner. |
pipeline.event.github.repository.url |
The URL of the repository that triggered the event. |
For full details on availability per VCS provider and trigger type, see the Pipeline values reference.