Skip to content

Commit ecabf65

Browse files
committed
docs: add env_id to secrets tables, remove api-url accordion, update env-id accordion
1 parent f4fae3e commit ecabf65

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
@@ -83,27 +83,22 @@ jobs:
8383
8484
Go to **Settings > Secrets and variables > Actions** and add:
8585
86-
| Secret | Description |
87-
|---|---|
88-
| `ELEMENTARY_API_KEY` | Your Elementary Cloud API key |
86+
| Secret | Required | Description |
87+
|---|---|---|
88+
| `ELEMENTARY_API_KEY` | Yes | Your Elementary Cloud API key |
89+
| `ELEMENTARY_ENV_ID` | No | Your Elementary environment ID. Only needed when the repository is connected to multiple environments. |
90+
91+
The environment ID is the UUID in your Elementary Cloud URL. For example, in `https://app.elementary-data.com/169e9308-9a70-4200-b810-ad486cb42f3a/report/dashboard`, the environment ID is `169e9308-9a70-4200-b810-ad486cb42f3a`.
8992

9093
That's it. The review only runs on PRs that touch model files. Other PRs are ignored entirely.
9194

9295
<Warning>
9396
This works for pull requests opened from branches within the same repository. GitHub does not pass repository secrets to `pull_request` workflows triggered by forks or Dependabot.
9497
</Warning>
9598

96-
<Accordion title="Optional: customize the action">
97-
98-
| Input | Default | Description |
99-
|---|---|---|
100-
| `elementary-api-url` | Elementary Cloud | Override the API URL. Only needed for self-hosted Elementary setups |
101-
102-
</Accordion>
103-
104-
<Accordion title="Optional: specify environment">
99+
<Accordion title="Optional: specify environment in the workflow">
105100

106-
If your repository is connected to multiple Elementary environments, add `env-id` to the request to specify which one to use:
101+
Instead of adding `ELEMENTARY_ENV_ID` as a repository secret, you can pass it directly in the workflow file:
107102

108103
```yaml
109104
- uses: elementary-data/elementary-ci@v1
@@ -112,9 +107,7 @@ If your repository is connected to multiple Elementary environments, add `env-id
112107
elementary-env-id: "169e9308-9a70-4200-b810-ad486cb42f3a"
113108
```
114109

115-
The environment ID is the UUID in your Elementary Cloud URL. For example, in `https://app.elementary-data.com/169e9308-9a70-4200-b810-ad486cb42f3a/report/dashboard`, the environment ID is `169e9308-9a70-4200-b810-ad486cb42f3a`.
116-
117-
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.
110+
If you don't specify an environment 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.
118111

119112
</Accordion>
120113

@@ -136,6 +129,7 @@ Go to **Settings > CI/CD > Variables** and add:
136129
| Variable | Masked | Required | Description |
137130
|---|---|---|---|
138131
| `ELEMENTARY_API_KEY` | Yes | Yes | Your Elementary Cloud API key |
132+
| `ELEMENTARY_ENV_ID` | Yes | No | Your Elementary environment ID. Only needed when the repository is connected to multiple environments. |
139133
| `GITLAB_API_TOKEN` | Yes | No | Project Access Token with `api` scope. Only needed if you cannot enable CI/CD job token access (see below). |
140134

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

0 commit comments

Comments
 (0)