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: README.md
+14-11Lines changed: 14 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
# Dataverse Uploader
2
2
3
3
This action automatically uploads GitHub repository content to a Dataverse dataset.
4
-
It can upload the entire repository or its subdirectory into an existing dataset on a target
4
+
It can upload the entire repository or its subdirectories into an existing dataset on a target
5
5
Dataverse installation. The action is customizable, allowing you to fully replace a dataset,
6
6
add to the dataset, publish it or leave it as a draft version on Dataverse.
7
7
@@ -17,7 +17,7 @@ To use this action, you will need the following input parameters:
17
17
|`DATAVERSE_TOKEN`|**Yes**| This is your personal access token that you can create at your Dataverse instance (see [the Dataverse guide](https://guides.dataverse.org/en/latest/user/account.html#how-to-create-your-api-token)). Save your token as a secret variable called `DATAVERSE_TOKEN` in your GitHub repository that you want to upload to Dataverse (see [the GitHub guide](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository)). |
18
18
|`DATAVERSE_SERVER`|**Yes**| The URL of your Dataverse installation, i.e., [https://dataverse.harvard.edu](https://dataverse.harvard.edu). |
19
19
|`DATAVERSE_DATASET_DOI`|**Yes**| This action requires that a dataset (with a DOI) exists on the Dataverse server. Make sure to specify your DOI in this format: `doi:<doi>`, i.e., `doi:10.70122/FK2/LVUA`. |
20
-
|`GITHUB_DIR`| No | Use `GITHUB_DIR` if you would like to upload files from only a specific subdirectory in your GitHub repository (i.e., just `data/`). |
20
+
|`GITHUB_DIR`| No | Use `GITHUB_DIR` if you would like to upload files from only one or more subdirectories in your GitHub repository (i.e., `data/`, `plots/`). |
21
21
|`DELETE`| No | Can be `True` or `False` (by default `True`) depending on whether all files should be deleted in the dataset on Dataverse before upload. |
22
22
|`PUBLISH`| No | Can be `True` or `False` (by default `False`) depending on whether you'd like to automatically create a new version of the dataset upon upload. If `False`, the uploaded dataset will be a `DRAFT`. |
23
23
@@ -39,7 +39,7 @@ jobs:
39
39
runs-on: ubuntu-latest
40
40
steps:
41
41
- name: Send repo to Dataverse
42
-
uses: IQSS/dataverse-uploader@v1.3
42
+
uses: IQSS/dataverse-uploader@v1.4
43
43
with:
44
44
DATAVERSE_TOKEN: ${{secrets.DATAVERSE_TOKEN}}
45
45
DATAVERSE_SERVER: https://demo.dataverse.org
@@ -52,20 +52,20 @@ you should add the `GITHUB_DIR` argument in your workflow, as follows:
52
52
```
53
53
steps:
54
54
- name: Send repo to Dataverse
55
-
uses: IQSS/dataverse-uploader@v1.3
55
+
uses: IQSS/dataverse-uploader@v1.4
56
56
with:
57
57
DATAVERSE_TOKEN: ${{secrets.DATAVERSE_TOKEN}}
58
58
DATAVERSE_SERVER: https://demo.dataverse.org
59
59
DATAVERSE_DATASET_DOI: doi:10.70122/FK2/LVUA
60
60
GITHUB_DIR: data
61
61
```
62
62
63
-
You can upload multiple subdirectories (only) by listing them as `GITHUB_DIR` in the following format:
63
+
You can upload multiple subdirectories by listing them as `GITHUB_DIR` like `GITHUB_DIR: data,plots`, or in the following format:
64
64
65
65
```
66
66
steps:
67
67
- name: Send repo to Dataverse
68
-
uses: IQSS/dataverse-uploader@v1.2
68
+
uses: IQSS/dataverse-uploader@v1.4
69
69
with:
70
70
DATAVERSE_TOKEN: ${{secrets.DATAVERSE_TOKEN}}
71
71
DATAVERSE_SERVER: https://demo.dataverse.org
@@ -83,7 +83,7 @@ set the `DELETE` argument to `False` like:
83
83
```
84
84
steps:
85
85
- name: Send repo to Dataverse
86
-
uses: IQSS/dataverse-uploader@v1.3
86
+
uses: IQSS/dataverse-uploader@v1.4
87
87
with:
88
88
DATAVERSE_TOKEN: ${{secrets.DATAVERSE_TOKEN}}
89
89
DATAVERSE_SERVER: https://demo.dataverse.org
@@ -99,7 +99,7 @@ set the `PUBLISH` argument to `True`.
99
99
```
100
100
steps:
101
101
- name: Send repo to Dataverse
102
-
uses: IQSS/dataverse-uploader@v1.3
102
+
uses: IQSS/dataverse-uploader@v1.4
103
103
with:
104
104
DATAVERSE_TOKEN: ${{secrets.DATAVERSE_TOKEN}}
105
105
DATAVERSE_SERVER: https://demo.dataverse.org
@@ -111,18 +111,21 @@ steps:
111
111
112
112
## Q&A
113
113
114
-
> If you change the content of your GitHub repository, are the changes synchronized in Dataverse?
115
-
> Otherwise, is it possible to synchronize them automatically?
114
+
1.**If you change the content of your GitHub repository, are the changes synchronized in Dataverse? Otherwise, is it possible to synchronize them automatically?**
116
115
117
116
Yes, the action is able to automatically update the Dataverse dataset. In other words, if the action
118
117
is triggered with every `push` to the GitHub repository, it will automatically upload its content to
119
118
Dataverse. You specify the action triggers in the workflow (`.yml`) file, and in this case, it would
120
119
contain `on: push` line to execute the action on every push to the repository.
121
120
122
-
> Will the action work with dataset Handles as persistent identifiers (PIDs) instead of DOIs?
121
+
2.**Will the action work with dataset Handles as persistent identifiers (PIDs) instead of DOIs?**
123
122
124
123
Yes, the action uses Dataverse API that supports both DOIs and Handles for retrieving and uploading data.
125
124
125
+
3.**How do I contribute to this project?**
126
+
127
+
Have a look at the instructions in the `CONTRIBUTING.md` file.
0 commit comments