Document CIRRUS_CLI_VERSION as a replacement to CIRRUS_AGENT_VERSION (#…

…1274)
cirruslabs · May 7, 2024 · 21dc15b · 21dc15b
1 parent b5dc523
commit 21dc15b
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/.spelling b/.spelling
@@ -20,7 +20,7 @@ CCMenu
 CCTray
 CCtray
 CI
-CIRRUS_AGENT_VERSION
+CIRRUS_CLI_VERSION
 CIRRUS_AGENT_EXPOSE_SCRIPTS_OUTPUTS
 CIRRUS_API_CREATED
 CIRRUS_BASE_BRANCH

diff --git a/docs/guide/writing-tasks.md b/docs/guide/writing-tasks.md
@@ -617,10 +617,10 @@ And some environment variables can be set to control behavior of the Cirrus CI A
 
 | Name                                | Default Value                                                                                                                                          | Description                                                                                                                                                                                                                                                                                                                                                                                                         |
 |-------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| CIRRUS_AGENT_VERSION                | not set                                                                                                                                                | Cirrus Agent version to use. If not set, the [latest release](https://github.com/cirruslabs/cirrus-ci-agent/releases)                                                                                                                                                                                                                                                                                               |
 | CIRRUS_AGENT_EXPOSE_SCRIPTS_OUTPUTS | not set                                                                                                                                                | If set, instructs Cirrus Agent to stream scripts outputs to the console as well as Cirrus API. Useful in case your Kubernetes cluster has logging collection enabled.                                                                                                                                                                                                                                               |
+| CIRRUS_CLI_VERSION                  | not set                                                                                                                                                | Cirrus CLI version to use when running the agent. If not set, the [latest release](https://github.com/cirruslabs/cirrus-cli/releases) will be used.                                                                                                                                                                                                                                                                 |
 | CIRRUS_CLONE_DEPTH                  | `0` which will reflect in a full clone of a single branch                                                                                              | Clone depth.                                                                                                                                                                                                                                                                                                                                                                                                        |
-| CIRRUS_CLONE_TAGS                   | `false` which will not fetch any tags                                                                                                                  | Whether to fetch git tags.                                                                                                                                                                                                                                                                                                                                                                                                        |
+| CIRRUS_CLONE_TAGS                   | `false` which will not fetch any tags                                                                                                                  | Whether to fetch git tags.                                                                                                                                                                                                                                                                                                                                                                                          |
 | CIRRUS_CLONE_SUBMODULES             | `false`                                                                                                                                                | Set to `true` to clone submodules recursively.                                                                                                                                                                                                                                                                                                                                                                      |
 | CIRRUS_LOG_TIMESTAMP                | `false`                                                                                                                                                | Indicate Cirrus Agent to prepend timestamp to each line of logs.                                                                                                                                                                                                                                                                                                                                                    |
 | CIRRUS_OIDC_TOKEN_AUDIENCE          | not set                                                                                                                                                | Allows to override `aud` claim for `CIRRUS_OIDC_TOKEN`.                                                                                                                                                                                                                                                                                                                                                             |