Commit 86ce3032 authored by Suzanne Selhorn's avatar Suzanne Selhorn

Merge branch 'docs-package-variables' into 'master'

Change usage of CI/CD variables terminology in package docs

See merge request gitlab-org/gitlab!54193
parents 098fa21c 2a2f0e26
...@@ -84,9 +84,9 @@ This example configures the pipeline with a single job, `publish`, which runs `s ...@@ -84,9 +84,9 @@ This example configures the pipeline with a single job, `publish`, which runs `s
The default `before_script` generates a temporary `.npmrc` that is used to authenticate to the Package Registry during the `publish` job. The default `before_script` generates a temporary `.npmrc` that is used to authenticate to the Package Registry during the `publish` job.
## Set up environment variables ## Set up CI/CD variables
As part of publishing a package, semantic-release increases the version number in `package.json`. For semantic-release to commit this change and push it back to GitLab, the pipeline requires a custom environment variable named `GITLAB_TOKEN`. To create this variable: As part of publishing a package, semantic-release increases the version number in `package.json`. For semantic-release to commit this change and push it back to GitLab, the pipeline requires a custom CI/CD variable named `GITLAB_TOKEN`. To create this variable:
1. Navigate to **Project > Settings > Access Tokens**. 1. Navigate to **Project > Settings > Access Tokens**.
1. Give the token a name, and select the `api` scope. 1. Give the token a name, and select the `api` scope.
......
...@@ -273,5 +273,5 @@ Output indicates that the package has been successfully installed. ...@@ -273,5 +273,5 @@ Output indicates that the package has been successfully installed.
WARNING: WARNING:
Never commit the `auth.json` file to your repository. To install packages from a CI/CD job, Never commit the `auth.json` file to your repository. To install packages from a CI/CD job,
consider using the [`composer config`](https://getcomposer.org/doc/articles/handling-private-packages.md#satis) tool with your personal access token consider using the [`composer config`](https://getcomposer.org/doc/articles/handling-private-packages.md#satis) tool with your personal access token
stored in a [GitLab CI/CD environment variable](../../../ci/variables/README.md) or in stored in a [GitLab CI/CD variable](../../../ci/variables/README.md) or in
[HashiCorp Vault](../../../ci/secrets/index.md). [HashiCorp Vault](../../../ci/secrets/index.md).
...@@ -144,7 +144,7 @@ Before you can build and push images by using GitLab CI/CD, you must authenticat ...@@ -144,7 +144,7 @@ Before you can build and push images by using GitLab CI/CD, you must authenticat
To use CI/CD to authenticate, you can use: To use CI/CD to authenticate, you can use:
- The `CI_REGISTRY_USER` variable. - The `CI_REGISTRY_USER` CI/CD variable.
This variable has read-write access to the Container Registry and is valid for This variable has read-write access to the Container Registry and is valid for
one job only. Its password is also automatically created and assigned to `CI_REGISTRY_PASSWORD`. one job only. Its password is also automatically created and assigned to `CI_REGISTRY_PASSWORD`.
...@@ -209,7 +209,7 @@ build: ...@@ -209,7 +209,7 @@ build:
- docker push $CI_REGISTRY/group/project/image:latest - docker push $CI_REGISTRY/group/project/image:latest
``` ```
You can also make use of [other variables](../../../ci/variables/README.md) to avoid hard-coding: You can also make use of [other CI/CD variables](../../../ci/variables/README.md) to avoid hard-coding:
```yaml ```yaml
build: build:
...@@ -382,7 +382,7 @@ The following example defines two stages: `build`, and `clean`. The ...@@ -382,7 +382,7 @@ The following example defines two stages: `build`, and `clean`. The
`build_image` job builds the Docker image for the branch, and the `build_image` job builds the Docker image for the branch, and the
`delete_image` job deletes it. The `reg` executable is downloaded and used to `delete_image` job deletes it. The `reg` executable is downloaded and used to
remove the image matching the `$CI_PROJECT_PATH:$CI_COMMIT_REF_SLUG` remove the image matching the `$CI_PROJECT_PATH:$CI_COMMIT_REF_SLUG`
[environment variable](../../../ci/variables/predefined_variables.md). [predefined CI/CD variable](../../../ci/variables/predefined_variables.md).
To use this example, change the `IMAGE_TAG` variable to match your needs: To use this example, change the `IMAGE_TAG` variable to match your needs:
......
...@@ -96,17 +96,17 @@ You can authenticate using: ...@@ -96,17 +96,17 @@ You can authenticate using:
Runners log in to the Dependency Proxy automatically. To pull through Runners log in to the Dependency Proxy automatically. To pull through
the Dependency Proxy, use the `CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX` the Dependency Proxy, use the `CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX`
environment variable: [predefined CI/CD variable](../../../ci/variables/predefined_variables.md):
```yaml ```yaml
# .gitlab-ci.yml # .gitlab-ci.yml
image: ${CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX}/node:latest image: ${CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX}/node:latest
``` ```
There are other additional predefined environment variables you can also use: There are other additional predefined CI/CD variables you can also use:
- `CI_DEPENDENCY_PROXY_USER`: A CI user for logging in to the Dependency Proxy. - `CI_DEPENDENCY_PROXY_USER`: A CI/CD user for logging in to the Dependency Proxy.
- `CI_DEPENDENCY_PROXY_PASSWORD`: A CI password for logging in to the Dependency Proxy. - `CI_DEPENDENCY_PROXY_PASSWORD`: A CI/CD password for logging in to the Dependency Proxy.
- `CI_DEPENDENCY_PROXY_SERVER`: The server for logging in to the Dependency Proxy. - `CI_DEPENDENCY_PROXY_SERVER`: The server for logging in to the Dependency Proxy.
- `CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX`: The image prefix for pulling images through the Dependency Proxy. - `CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX`: The image prefix for pulling images through the Dependency Proxy.
...@@ -119,7 +119,7 @@ Proxy manually without including the port: ...@@ -119,7 +119,7 @@ Proxy manually without including the port:
docker pull gitlab.example.com:443/my-group/dependency_proxy/containers/alpine:latest docker pull gitlab.example.com:443/my-group/dependency_proxy/containers/alpine:latest
``` ```
You can also use [custom environment variables](../../../ci/variables/README.md#custom-cicd-variables) to store and access your personal access token or other valid credentials. You can also use [custom CI/CD variables](../../../ci/variables/README.md#custom-cicd-variables) to store and access your personal access token or other valid credentials.
### Store a Docker image in Dependency Proxy cache ### Store a Docker image in Dependency Proxy cache
......
...@@ -732,7 +732,7 @@ You can create a new package each time the `master` branch is updated. ...@@ -732,7 +732,7 @@ You can create a new package each time the `master` branch is updated.
``` ```
1. Make sure your `pom.xml` file includes the following. 1. Make sure your `pom.xml` file includes the following.
You can either let Maven use the CI environment variables, as shown in this example, You can either let Maven use the [predefined CI/CD variables](../../../ci/variables/predefined_variables.md), as shown in this example,
or you can hard code your server's hostname and project's ID. or you can hard code your server's hostname and project's ID.
```xml ```xml
...@@ -771,7 +771,7 @@ The next time the `deploy` job runs, it copies `ci_settings.xml` to the ...@@ -771,7 +771,7 @@ The next time the `deploy` job runs, it copies `ci_settings.xml` to the
user's home location. In this example: user's home location. In this example:
- The user is `root`, because the job runs in a Docker container. - The user is `root`, because the job runs in a Docker container.
- Maven uses the configured CI [environment variables](../../../ci/variables/README.md#predefined-cicd-variables). - Maven uses the configured CI/CD variables.
### Create Maven packages with GitLab CI/CD by using Gradle ### Create Maven packages with GitLab CI/CD by using Gradle
......
...@@ -199,7 +199,7 @@ Then, you can run `npm publish` either locally or by using GitLab CI/CD. ...@@ -199,7 +199,7 @@ Then, you can run `npm publish` either locally or by using GitLab CI/CD.
NPM_TOKEN=<your_token> npm publish NPM_TOKEN=<your_token> npm publish
``` ```
- **GitLab CI/CD:** Set an `NPM_TOKEN` [variable](../../../ci/variables/README.md) - **GitLab CI/CD:** Set an `NPM_TOKEN` [CI/CD variable](../../../ci/variables/README.md)
under your project's **Settings > CI/CD > Variables**. under your project's **Settings > CI/CD > Variables**.
## Package naming convention ## Package naming convention
...@@ -450,7 +450,7 @@ And the `.npmrc` file should look like: ...@@ -450,7 +450,7 @@ And the `.npmrc` file should look like:
### `npm install` returns `Error: Failed to replace env in config: ${npm_TOKEN}` ### `npm install` returns `Error: Failed to replace env in config: ${npm_TOKEN}`
You do not need a token to run `npm install` unless your project is private. The token is only required to publish. If the `.npmrc` file was checked in with a reference to `$npm_TOKEN`, you can remove it. If you prefer to leave the reference in, you must set a value prior to running `npm install` or set the value by using [GitLab environment variables](../../../ci/variables/README.md): You do not need a token to run `npm install` unless your project is private. The token is only required to publish. If the `.npmrc` file was checked in with a reference to `$npm_TOKEN`, you can remove it. If you prefer to leave the reference in, you must set a value prior to running `npm install` or set the value by using [GitLab CI/CD variables](../../../ci/variables/README.md):
```shell ```shell
NPM_TOKEN=<your_token> npm install NPM_TOKEN=<your_token> npm install
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment