add docs for CIRRUS_CLONE_TAGS (#1273)

* add docs for `CIRRUS_CLONE_TAGS` * remove stupid whitespace changes * fix naming * add CIRRUS_CLONE_TAGS to .spelling
cirruslabs · Apr 4, 2024 · b5dc523 · b5dc523
1 parent f69dfad
commit b5dc523
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 1 deletion.
diff --git a/.spelling b/.spelling
@@ -32,6 +32,7 @@ CIRRUS_CHANGE_MESSAGE
 CIRRUS_CHANGE_TITLE
 CIRRUS_CI
 CIRRUS_CLONE_DEPTH
+CIRRUS_CLONE_TAGS
 CIRRUS_CLONE_SUBMODULES
 CIRRUS_CPU
 CIRRUS_CRON

diff --git a/docs/guide/tips-and-tricks.md b/docs/guide/tips-and-tricks.md
@@ -20,7 +20,17 @@ task:
   # ...
 ```
 
-In addition if you need to use Git tags, you can add the following script to populate this information:
+In addition if you need to use Git tags, set `CIRRUS_CLONE_TAGS` environment variable to `true`:
+
+```yaml
+build_task:
+  environment:
+    CIRRUS_CLONE_TAGS: true
+  fetch_deps_script: ...
+```
+
+You can also use the script below, but note that it requires `git` to be present
+in the container:
 
 ```yaml
 task:

diff --git a/docs/guide/writing-tasks.md b/docs/guide/writing-tasks.md
@@ -620,6 +620,7 @@ And some environment variables can be set to control behavior of the Cirrus CI A
 | 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_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_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`.                                                                                                                                                                                                                                                                                                                                                             |