You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/cloud/features/ci.mdx
+10-16Lines changed: 10 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -83,27 +83,22 @@ jobs:
83
83
84
84
Go to **Settings > Secrets and variables > Actions** and add:
85
85
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`.
89
92
90
93
That's it. The review only runs on PRs that touch model files. Other PRs are ignored entirely.
91
94
92
95
<Warning>
93
96
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.
94
97
</Warning>
95
98
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">
105
100
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:
107
102
108
103
```yaml
109
104
- uses: elementary-data/elementary-ci@v1
@@ -112,9 +107,7 @@ If your repository is connected to multiple Elementary environments, add `env-id
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.
118
111
119
112
</Accordion>
120
113
@@ -136,6 +129,7 @@ Go to **Settings > CI/CD > Variables** and add:
136
129
| Variable | Masked | Required | Description |
137
130
|---|---|---|---|
138
131
| `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. |
139
133
| `GITLAB_API_TOKEN` | Yes | No | Project Access Token with `api` scope. Only needed if you cannot enable CI/CD job token access (see below). |
140
134
141
135
To post the MR comment, the template uses one of two authentication methods:
0 commit comments