Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document CIRRUS_CLONE_DIR #847

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Document CIRRUS_CLONE_DIR #847

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/guide/writing-tasks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -422,10 +422,11 @@ And some environment variables can be set to control behavior of the Cirrus CI A
Name | Default Value | Description
--- | --- | ---
CIRRUS_CLONE_DEPTH | `0` which will reflect in a full clone of a single branch | Clone depth.
CIRRUS_CLONE_DIR | Defaults to `$CIRRUS_WORKING_DIR` if not empty and doesn't contain `$CIRRUS_CLONE_DIR` itself. Othervise `CIRRUS_CLONE_DIR` is set to `cirrus-ci-build` folder inside of a system's temporary folder | Directory to put repository sources into.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this needs new definition to be introduced across the documentation (e.g. a scratch directory) to simplify the explanation.

Otherwise the reader needs to keep the track of all these cross-references between CIRRUS_CLONE_DIR and CIRRUS_WORKING_DIR in their memory.

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_SHELL | `sh` on Linux/macOS/FreeBSD and `cmd.exe` on Windows. Set to `direct` to execute each script directly without wrapping the commands in a shell script. | Shell that Cirrus CI uses to execute scripts. By default `sh` is used.
CIRRUS_WORKING_DIR | `cirrus-ci-build` folder inside of a system's temporary folder | Working directory where Cirrus CI executes builds. Default to `cirrus-ci-build` folder inside of a system's temporary folder.
CIRRUS_WORKING_DIR | `$CIRRUS_CLONE_DIR` | Working directory where Cirrus CI executes [instructions](#supported-instructions). Can be handy to override in monorepos for tasks targeting specific project in a sub-folder, e.g., `$CIRRUS_CLONE_DIR/frontend`.

## Encrypted Variables

Expand Down