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: content/api/cli.md
+24-6Lines changed: 24 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -48,19 +48,37 @@ In these commands:
48
48
49
49
## Publishing dataset
50
50
51
-
{{< refItem name="ota dataset [--file <filename>]" description="Export the versions dataset into a ZIP file and publish it to GitHub releases. The dataset title and the URL of the versions repository are defined in the configuration." example="npx ota dataset --file dataset.zip" />}}
51
+
{{< refItem name="ota dataset [--file <filename>]" description="Export the versions dataset into a ZIP file. The dataset title is defined in the configuration." example="npx ota dataset --file dataset.zip" />}}
52
52
53
-
To export the dataset into a ZIP file and publish it on GitHub releases:
53
+
To export the dataset into a ZIP file and publish it to configured platforms (GitHub releases, GitLab releases, and/or data.gouv.fr):
54
54
55
-
{{< refItem name="ota dataset --publish [--file <filename>]" description="Export and publish dataset to GitHub releases" example="GITHUB_TOKEN=ghp_XXXXXXXXX npx ota dataset --publish" />}}
55
+
{{< refItem name="ota dataset --publish [--file <filename>]" description="Export and publish dataset to all configured platforms" example="npx ota dataset --publish" />}}
56
56
57
-
The `GITHUB_TOKEN` can also be defined in a [`.env` file]({{< relref "collections/reference/environment-variables" >}}).
57
+
The dataset can be published to multiple platforms simultaneously:
Copy file name to clipboardExpand all lines: content/collections/reference/configuration.md
+19-1Lines changed: 19 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -180,7 +180,7 @@ The reporter section manages how issues are reported when terms content is inacc
180
180
181
181
### Dataset
182
182
183
-
The dataset section configures how datasets are published.
183
+
The dataset section configures how datasets are published. Datasets can be published to GitHub releases, GitLab releases, and/or data.gouv.fr. If both GitHub and GitLab tokens are configured, GitHub takes precedence.
184
184
185
185
{{< refItem
186
186
name="dataset.title"
@@ -203,6 +203,24 @@ The dataset section configures how datasets are published.
203
203
default="30 8 * * MON"
204
204
/>}}
205
205
206
+
#### data.gouv.fr publishing
207
+
208
+
The data.gouv.fr section configures publishing to the French government's open data platform.
209
+
210
+
{{< refItem
211
+
name="dataset.datagouv.datasetId"
212
+
type="string"
213
+
description="ID of the dataset on data.gouv.fr. Required for publishing to data.gouv.fr. Must be created manually on the data.gouv.fr website."
214
+
example="6914a64b17a0a91bb0a61222"
215
+
/>}}
216
+
217
+
{{< refItem
218
+
name="dataset.datagouv.useDemo"
219
+
type="boolean"
220
+
description="Set to true to use the demo.data.gouv.fr environment for testing."
221
+
default="false"
222
+
/>}}
223
+
206
224
### Collection API
207
225
208
226
The collection API section sets the parameters for the API server.
Copy file name to clipboardExpand all lines: content/collections/reference/environment-variables.md
+4-2Lines changed: 4 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,12 +13,14 @@ This reference documentation details all available environment variables that ca
13
13
14
14
{{< refItem name="OTA_ENGINE_SENDINBLUE_API_KEY" type="string" description="API key for SendInBlue." />}}
15
15
16
-
{{< refItem name="OTA_ENGINE_GITHUB_TOKEN" type="string" description="GitHub token for API access." />}}
16
+
{{< refItem name="OTA_ENGINE_GITHUB_TOKEN" type="string" description="GitHub token for API access and dataset publishing. If both GitHub and GitLab tokens are configured, GitHub takes precedence for dataset publishing." />}}
17
17
18
-
{{< refItem name="OTA_ENGINE_GITLAB_TOKEN" type="string" description="GitLab token for API access." />}}
18
+
{{< refItem name="OTA_ENGINE_GITLAB_TOKEN" type="string" description="GitLab token for API access and dataset publishing. Used only if GitHub token is not configured." />}}
19
19
20
20
{{< refItem name="OTA_ENGINE_GITLAB_RELEASES_TOKEN" type="string" description="GitLab token for dataset releases." />}}
21
21
22
+
{{< refItem name="OTA_ENGINE_DATAGOUV_API_KEY" type="string" description="API key for data.gouv.fr dataset publishing. Requires dataset.datagouv.datasetId to be configured." />}}
0 commit comments