pipeline-preview-docs

Available pipeline variables

For information on how these pipeline variables would be used in your configuration see the overview of pipeline variables.

Not all values will be available in all circumstances, for instance, the first push to a repository will not have a pipeline.trigger.base_revision. If a value isn’t available it will resolve to an empty string during config expansion, values documented as having a boolean type will resolve to false.

(THIS LIST IS UNDER DESIGN - FEEDBACK WELCOMED.)

First batch:

• pipeline.id - a globally unique id representing the pipeline
• pipeline.number - a project unique integer id for the pipeline
• pipeline.project.git_url - e.g. https://github.com/circleci/circleci-docs
• pipeline.project.type - e.g. “github”
• pipeline.git.tag - the tag triggering the pipeline
• pipeline.git.branch - the branch triggering the pipeline
• pipeline.git.revision - the current git revision
• pipeline.git.base_revision - the previous git revision

Second batch:

• pipeline.project.name
• pipeline.project_slug
• pipeline.created_timestamp
• pipeline.trigger.rerun_of
• pipeline.trigger.actor

Other potential variables:

• pipeline.pull_request.draft (boolean)
• pipeline.pull_request.number
• pipeline.pull_request.url
• pipeline.pull_request.source_branch
• pipeline.pull_request.source_repo
• pipeline.pull_request.target_branch
• pipeline.pull_request.target_repo

• pipeline.pull_request.fork (boolean - useful, or should we prefer comparing source/target?)

• pipeline.project.default_branch
• pipeline.project.organization_name

(Speculative):

• pipeline.project.settings.*