Skip to content
This repository was archived by the owner on Mar 13, 2024. It is now read-only.

Commit d391d56

Browse files
authored
feat(docs): update documentation on supported runners (#162)
Signed-off-by: Mattia Buccarella <[email protected]>
1 parent f398838 commit d391d56

File tree

1 file changed

+27
-2
lines changed

1 file changed

+27
-2
lines changed

docs/reference/operator/contract.mdx

+27-2
Original file line numberDiff line numberDiff line change
@@ -126,11 +126,11 @@ The following environment variables will be automatically added to the attestati
126126
- `CI_RUNNER_DESCRIPTION`
127127
- `CI_COMMIT_REF_NAME`
128128

129-
A link to the Gitlab CI job will be recorded in the control plane too during initialization.
129+
A link to the Gitlab CI job will be recorded in the control plane too, during initialization.
130130

131131
### `AZURE_PIPELINE`
132132

133-
The following environment variables will be automatically added to the attestation. For more information on what they mean refer to [this link](https://learn.microsoft.com/en-us/azure/devops/pipelines/build/variables?view=azure-devops&tabs=yaml).
133+
The following environment variables will be automatically added to the attestation. For more information on what they mean, refer to [this link](https://learn.microsoft.com/en-us/azure/devops/pipelines/build/variables?view=azure-devops&tabs=yaml).
134134

135135
- `BUILD_REQUESTEDFOREMAIL`
136136
- `BUILD_REQUESTEDFOR`
@@ -145,6 +145,31 @@ The following environment variables will be automatically added to the attestati
145145

146146
A link to the Azure Pipeline build will be recorded in the control plane too during initialization.
147147

148+
### `JENKINS_JOB`
149+
150+
The following environment variables will be automatically added to the attestation. For more information on how to use Jenkins environment variables, refer to [the official Jenkins documentation](https://www.jenkins.io/doc/book/pipeline/jenkinsfile/#using-environment-variables).
151+
152+
- `JOB_NAME`
153+
- `BUILD_URL`
154+
- `GIT_BRANCH` (optional)
155+
- `GIT_COMMIT` (optional)
156+
- `AGENT_WORKDIR`
157+
- `NODE_NAME`
158+
159+
A link to the build will be recorded in the control plane too, during initialization.
160+
161+
### `CIRCLECI_BUILD`
162+
163+
The following environment variables will be automatically added to the attestation. For more information on their meaning, refer to [the official CircleCI documentation](https://circleci.com/docs/variables/).
164+
165+
- `CIRCLE_BUILD_URL`
166+
- `CIRCLE_JOB`
167+
- `CIRCLE_BRANCH` (optional)
168+
- `CIRCLE_NODE_TOTAL`
169+
- `CIRCLE_NODE_INDEX`
170+
171+
A link to the CircleCI build will be recorded in the control plane too, during initialization.
172+
148173
:::tip
149174
Remember, if all the **env variables** that you need are not defined in the context, you can extend such list via the `envAllowList` option.
150175
:::

0 commit comments

Comments
 (0)