README.md.gotmpl

# magda-minion-ckan-exporter

MAGDA Minion for exporting datasets to CKAN

## Description

TLDR: This minion exports datasets as open data to a CKAN instance (e.g, data.gov.au)

During the add dataset flow, in the `Access and User` section,
the user can choose whether or not to publish the dataset as open data (`No` by default).

At the moment, it only exports the dataset to data.gov.au.

## How it works

On publishing of the dataset to MAGDA, the minion will create an equivalent CKAN package
and upload it to CKAN via the [CKAN Api](https://docs.ckan.org/en/ckan-2.7.3/api/) and
store the `CkanId` returned by CKAN.

If the dataset is edited, the entire dataset is uploaded again, but as an update.

If the user chooses to not have the dataset available as open data anymore, the dataset
is deleted from the CKAN instance.

### Local Dev

For instructions on working on this minion, refer to [local-dev.md](./local-dev.md).

If you would like to build a connector or a minion for MAGDA,
here is a handy
[guide](https://github.com/magda-io/magda/blob/master/docs/docs/how-to-build-your-own-connectors-minions.md).

### Release Registry

Since v2.0.0, we use [Github Container Registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry) as our official Helm Chart & Docker Image release registry.

It's recommended to deploy minions with as [dependencies](https://helm.sh/docs/topics/chart_best_practices/dependencies/) of a Magda helm deployment.

```yaml
dependencies:
  - name: magda-minion-ckan-exporter
    version: "2.0.0"
    repository: "oci://ghcr.io/magda-io/charts"
```

{{ template "chart.maintainersSection" . }}

{{ template "chart.requirementsSection" . }}

{{ template "chart.valuesHeader" . }}

{{ template "chart.valuesTable" . }}