diff options
| author | John Spaetzel <john.spaetzel@gmail.com> | 2017-04-14 19:01:52 -0400 |
|---|---|---|
| committer | Achilleas Pipinellis <axilleas@axilleas.me> | 2017-06-06 15:02:03 +0200 |
| commit | 1d0219a52660f4b242a085c1a34311714bb384cf (patch) | |
| tree | e6e0cae12296e54da9350187c901338ec6703843 | |
| parent | 34f925fe0bebdc7212c1c960678114a4e44828ef (diff) | |
| download | gitlab-ce-docs/powershell-ci-vars.tar.gz | |
Add PowerShell to CI variable docsdocs/powershell-ci-vars
| -rw-r--r-- | doc/ci/variables/README.md | 34 | ||||
| -rw-r--r-- | doc/ci/yaml/README.md | 19 |
2 files changed, 49 insertions, 4 deletions
diff --git a/doc/ci/variables/README.md b/doc/ci/variables/README.md index 56ff245f9f9..04ce3cbcaa8 100644 --- a/doc/ci/variables/README.md +++ b/doc/ci/variables/README.md @@ -345,20 +345,45 @@ All variables are set as environment variables in the build environment, and they are accessible with normal methods that are used to access such variables. In most cases `bash` or `sh` is used to execute the job script. -To access the variables (predefined and user-defined) in a `bash`/`sh` environment, -prefix the variable name with the dollar sign (`$`): +To access environment variables, use the syntax for your Runner's [shell][shellexecutors]. -``` +| Shell | Usage | +|----------------------|-----------------| +| bash/sh | `$variable` | +| windows batch | `%variable%` | +| PowerShell | `$env:variable` | + +To access environment variables in bash, prefix the variable name with (`$`): + +```yaml job_name: script: - echo $CI_JOB_ID ``` +To access environment variables in **Windows Batch**, surround the variable +with (`%`): + +```yaml +job_name: + script: + - echo %CI_JOB_ID% +``` + +To access environment variables in a **Windows PowerShell** environment, prefix +the variable name with (`$env:`): + +```yaml +job_name: + script: + - echo $env:CI_JOB_ID +``` + You can also list all environment variables with the `export` command, but be aware that this will also expose the values of all the secret variables you set, in the job log: -``` +```yaml job_name: script: - export @@ -405,3 +430,4 @@ export CI_REGISTRY_PASSWORD="longalfanumstring" [triggers]: ../triggers/README.md#pass-job-variables-to-a-trigger [protected branches]: ../../user/project/protected_branches.md [protected tags]: ../../user/project/protected_tags.md +[shellexecutors]: https://docs.gitlab.com/runner/executors/ diff --git a/doc/ci/yaml/README.md b/doc/ci/yaml/README.md index 2c9aa437932..52d7a33fc9d 100644 --- a/doc/ci/yaml/README.md +++ b/doc/ci/yaml/README.md @@ -297,6 +297,15 @@ cache: untracked: true ``` +If you use **Windows PowerShell** to run your shell scripts you need to replace +`$` with `$env:`: + +```yaml +cache: + key: "$env:CI_JOB_STAGE/$env:CI_COMMIT_REF_NAME" + untracked: true +``` + ## Jobs `.gitlab-ci.yml` allows you to specify an unlimited number of jobs. Each job @@ -909,6 +918,16 @@ job: untracked: true ``` +If you use **Windows PowerShell** to run your shell scripts you need to replace +`$` with `$env:`: + +```yaml +job: + artifacts: + name: "$env:CI_JOB_STAGE_$env:CI_COMMIT_REF_NAME" + untracked: true +``` + #### artifacts:when > Introduced in GitLab 8.9 and GitLab Runner v1.3.0. |