Skip to content

Commit f4fae3e

Browse files
committed
docs: clarify GitLab CI setup and make GITLAB_API_TOKEN optional clearer
1 parent 03d55bb commit f4fae3e

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

docs/cloud/features/ci.mdx

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,8 @@ If you don't specify an `env-id` and the repository is connected to only one env
122122

123123
**Step 1 -- Add the include to your `.gitlab-ci.yml`**
124124

125+
GitLab CI pipelines are configured via a `.gitlab-ci.yml` file in the root of your repository. Add the following `include` block to pull in the Elementary review template. If you already have a `.gitlab-ci.yml`, just add the `include` section to it.
126+
125127
```yaml
126128
include:
127129
- remote: 'https://raw.githubusercontent.com/elementary-data/elementary-ci/v1/templates/mr-review.yml'
@@ -131,10 +133,10 @@ include:
131133

132134
Go to **Settings > CI/CD > Variables** and add:
133135

134-
| Variable | Masked | Description |
135-
|---|---|---|
136-
| `ELEMENTARY_API_KEY` | Yes | Your Elementary Cloud API key |
137-
| `GITLAB_API_TOKEN` | Yes | Optional. Project Access Token with `api` scope. Set this if you cannot enable CI/CD job token API access in project settings. |
136+
| Variable | Masked | Required | Description |
137+
|---|---|---|---|
138+
| `ELEMENTARY_API_KEY` | Yes | Yes | Your Elementary Cloud API key |
139+
| `GITLAB_API_TOKEN` | Yes | No | Project Access Token with `api` scope. Only needed if you cannot enable CI/CD job token access (see below). |
138140

139141
To post the MR comment, the template uses one of two authentication methods:
140142

0 commit comments

Comments
 (0)