Skip to content

docs: lowercase secret names, remove api-url accordion #2191

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
joostboon merged 1 commit into from
Apr 15, 2026
+6 −15
Merged

docs: lowercase secret names, remove api-url accordion #2191

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 6 additions & 15 deletions docs/cloud/features/ci.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,8 @@ When a PR is opened or updated:

| Secret | Required | Description |
|---|---|---|
| `ELEMENTARY_API_KEY` | Yes | Your Elementary Cloud API key |
| `ELEMENTARY_ENV_ID` | No | Your Elementary environment ID. Only needed when the repository is connected to multiple environments. |
| `elementary_api_key` | Yes | Your Elementary Cloud API key |
| `elementary_env_id` | No | Your Elementary environment ID. Only needed when the repository is connected to multiple environments. |

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

Expand All @@ -86,15 +86,7 @@ When a PR is opened or updated:
</Step>
</Steps>

<AccordionGroup>
<Accordion title="Optional: customize the action">

| Input | Default | Description |
|---|---|---|
| `elementary-api-url` | Elementary Cloud | Override the API URL. Only needed for self-hosted Elementary setups |

</Accordion>
<Accordion title="Optional: specify environment">
<Accordion title="Optional: specify environment">

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

Expand All @@ -110,7 +102,6 @@ When a PR is opened or updated:
If you don't specify an `env-id` and the repository is connected to only one environment, it will be selected automatically. If connected to multiple, the review will return an error listing the available environment IDs.

</Accordion>
</AccordionGroup>

### GitLab CI

Expand All @@ -126,9 +117,9 @@ When a PR is opened or updated:

| Variable | Masked | Required | Description |
|---|---|---|---|
| `ELEMENTARY_API_KEY` | Yes | Yes | Your Elementary Cloud API key |
| `ELEMENTARY_ENV_ID` | Yes | No | Your Elementary environment ID. Only needed when the repository is connected to multiple environments. |
| `GITLAB_API_TOKEN` | Yes | No | Project Access Token with `api` scope. Only needed if you cannot enable CI/CD job token access (see below). |
| `elementary_api_key` | Yes | Yes | Your Elementary Cloud API key |
| `elementary_env_id` | Yes | No | Your Elementary environment ID. Only needed when the repository is connected to multiple environments. |
| `gitlab_api_token` | Yes | No | Project Access Token with `api` scope. Only needed if you cannot enable CI/CD job token access (see below). |

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

Expand Down
Loading