This GitHub Action serves as a powerful tool to effortlessly create a functional Dataverse instance, enabling developers to run comprehensive tests and perform other critical tasks within their GitHub CI workflows.
In order to use the baseline action you need to add the following to your workflow file:
name: Run Dataverse Action
id: dataverse
uses: gdcc/dataverse-action@main
This will create a Dataverse instance with the default configuration. The action will output the API token and base URL of the instance, which can be used to interact with the instance. Here is an example on how to re-use the API token and base URL in a subsequent step:
name: How to re-use outputs
env:
API_TOKEN: ${{ steps.dataverse.outputs.api_token }}
BASE_URL: ${{ steps.dataverse.outputs.base_url }}
run: |
my-app --api-token "${{ env.API_TOKEN }}" --base-url "${{ env.BASE_URL }}"
INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
---|---|---|---|---|
create-dv | string | true | "true" |
Whether or not to create an example Dataverse |
image_configbaker | string | true | "docker.io/gdcc/configbaker" |
Name of Configbaker image (can include registry) |
image_dataverse | string | true | "docker.io/gdcc/dataverse" |
Name of Dataverse app image (can include registry) |
image_tag | string | true | "unstable" |
Tag of image for Dataverse app and Configbaker |
jvm_options | string | false | Line separated key-value pairs of JVM options to be set before startup. Example: dataverse.spi.exporters.directory=/... |
|
postgresql_version | string | false | Override the PostgreSQL version to use |
|
solr_version | string | false | Override the Solr version to use |
OUTPUT | TYPE | DESCRIPTION |
---|---|---|
api_token | string | API Token of dataverseAdmin superuser |
base_url | string | Base URL where to reach the instance via HTTP |
This project is licensed under the MIT License - see the LICENSE file for details.