Skip to content

Commit fe20463

Browse files
author
Glen Mailer
committed
Make it clearer whether working directories are relative or absolute
1 parent c62229f commit fe20463

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

jekyll/_cci2/configuration-reference.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ machine | Y <sup>(1)</sup> | Map | Options for [machine executor](#machine)
9999
macos | Y <sup>(1)</sup> | Map | Options for [macOS executor](#macos)
100100
windows | Y <sup>(1)</sup> | Map | [Windows executor](#windows) currently working with orbs. Check out [the orb](https://circleci.com/orbs/registry/orb/circleci/windows).
101101
shell | N | String | Shell to use for execution command in all steps. Can be overridden by `shell` in each step (default: See [Default Shell Options](#default-shell-options))
102-
working_directory | N | String | In which directory to run the steps.
102+
working_directory | N | String | In which directory to run the steps. Will be interpreted as an absolute path.
103103
environment | N | Map | A map of environment variable names and values.
104104
{: class="table table-striped"}
105105

@@ -146,7 +146,7 @@ macos | Y <sup>(1)</sup> | Map | Options for [macOS executor](#macos)
146146
shell | N | String | Shell to use for execution command in all steps. Can be overridden by `shell` in each step (default: See [Default Shell Options](#default-shell-options))
147147
parameters | N | Map | [Parameters](#parameters) for making a `job` explicitly configurable in a `workflow`.
148148
steps | Y | List | A list of [steps](#steps) to be performed
149-
working_directory | N | String | In which directory to run the steps. Default: `~/project` (where `project` is a literal string, not the name of your specific project). Processes run during the job can use the `$CIRCLE_WORKING_DIRECTORY` environment variable to refer to this directory. **Note:** Paths written in your YAML configuration file will _not_ be expanded; if your `store_test_results.path` is `$CIRCLE_WORKING_DIRECTORY/tests`, then CircleCI will attempt to store the `test` subdirectory of the directory literally named `$CIRCLE_WORKING_DIRECTORY`, dollar sign `$` and all.
149+
working_directory | N | String | In which directory to run the steps. Will be interpreted as an absolute path. Default: `~/project` (where `project` is a literal string, not the name of your specific project). Processes run during the job can use the `$CIRCLE_WORKING_DIRECTORY` environment variable to refer to this directory. **Note:** Paths written in your YAML configuration file will _not_ be expanded; if your `store_test_results.path` is `$CIRCLE_WORKING_DIRECTORY/tests`, then CircleCI will attempt to store the `test` subdirectory of the directory literally named `$CIRCLE_WORKING_DIRECTORY`, dollar sign `$` and all.
150150
parallelism | N | Integer | Number of parallel instances of this job to run (default: 1)
151151
environment | N | Map | A map of environment variable names and values.
152152
branches | N | Map | A map defining rules to allow/block execution of specific branches for a single job that is **not** in a workflow or a 2.1 config (default: all allowed). See [Workflows](#workflows) for configuring branch execution for jobs in a workflow or 2.1 config.
@@ -664,7 +664,7 @@ name | N | String | Title of the step to be shown in the CircleCI UI (default: f
664664
shell | N | String | Shell to use for execution command (default: See [Default Shell Options](#default-shell-options))
665665
environment | N | Map | Additional environmental variables, locally scoped to command
666666
background | N | Boolean | Whether or not this step should run in the background (default: false)
667-
working_directory | N | String | In which directory to run this step (default: [`working_directory`](#jobs) of the job)
667+
working_directory | N | String | In which directory to run this step. Will be interpreted relative to the [`working_directory`](#jobs) of the job). (default: `.`)
668668
no_output_timeout | N | String | Elapsed time the command can run without output. The string is a decimal with unit suffix, such as "20m", "1.25h", "5s" (default: 10 minutes)
669669
when | N | String | [Specify when to enable or disable the step](#the-when-attribute). Takes the following values: `always`, `on_success`, `on_fail` (default: `on_success`)
670670
{: class="table table-striped"}
@@ -865,7 +865,7 @@ A special step used to check out source code to the configured `path` (defaults
865865
866866
Key | Required | Type | Description
867867
----|-----------|------|------------
868-
path | N | String | Checkout directory (default: job's [`working_directory`](#jobs))
868+
path | N | String | Checkout directory. Will be interpreted relative to the [`working_directory`](#jobs) of the job). (default: `.`)
869869
{: class="table table-striped"}
870870
871871
If `path` already exists and is:

0 commit comments

Comments
 (0)