Skip to content

Commit fe60242

Browse files
committed
docs: add ELEMENTARY_ENV_ID to secrets tables, clarify optional fields
1 parent 07151d0 commit fe60242

1 file changed

Lines changed: 10 additions & 16 deletions

File tree

docs/cloud/features/ci.mdx

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,10 @@ When a PR is opened or updated:
7373
<Step title="Add a repository secret">
7474
Go to **Settings > Secrets and variables > Actions** in your GitHub repository and add:
7575
76-
| Secret | Description |
77-
|---|---|
78-
| `ELEMENTARY_API_KEY` | Your Elementary Cloud API key |
76+
| Secret | Required | Description |
77+
|---|---|---|
78+
| `elementary_api_key` | Yes | Your Elementary Cloud API key |
79+
| `elementary_env_id` | No | Your Elementary environment ID. Only needed when the repository is connected to multiple environments. |
7980

8081
The review only runs on PRs that touch model files. Other PRs are ignored.
8182

@@ -85,15 +86,7 @@ When a PR is opened or updated:
8586
</Step>
8687
</Steps>
8788

88-
<AccordionGroup>
89-
<Accordion title="Optional: customize the action">
90-
91-
| Input | Default | Description |
92-
|---|---|---|
93-
| `elementary-api-url` | Elementary Cloud | Override the API URL. Only needed for self-hosted Elementary setups |
94-
95-
</Accordion>
96-
<Accordion title="Optional: specify environment">
89+
<Accordion title="Optional: specify environment">
9790

9891
If your repository is connected to multiple Elementary environments, add `env-id` to specify which one to use:
9992

@@ -123,10 +116,11 @@ When a PR is opened or updated:
123116
<Step title="Add CI/CD variables">
124117
Go to **Settings > CI/CD > Variables** and add:
125118

126-
| Variable | Masked | Description |
127-
|---|---|---|
128-
| `ELEMENTARY_API_KEY` | Yes | Your Elementary Cloud API key |
129-
| `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. |
119+
| Variable | Masked | Required | Description |
120+
|---|---|---|---|
121+
| `elementary_api_key` | Yes | Yes | Your Elementary Cloud API key |
122+
| `elementary_env_id` | Yes | No | Your Elementary environment ID. Only needed when the repository is connected to multiple environments. |
123+
| `gitlab_api_token` | Yes | No | Project Access Token with `api` scope. Only needed if you cannot enable CI/CD job token access (see below). |
130124

131125
To post the MR comment, the template uses one of two authentication methods:
132126

0 commit comments

Comments
 (0)