Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jspaaks authored Jun 23, 2021
1 parent 7749a58 commit a971d60
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ Automates drafting depositions on Zenodo or Zenodo Sandbox.

## Features

1. Choose which platform you want to draft your deposition on (Zenodo or Zenodo Sandbox), and easily switch between them
2. Choose to create your draft deposition as a new version in an existing collection, or as a new deposition in a new collection
3. Choose to finalize the deposition as part of the automation, or leave the deposition as draft for you to inspect and publish manually by clicking the button on Zenodo or Zenodo Sandbox
4. Publish a snapshot of the repository as a zip or tar.gz
5. Instead of publishing a snapshot, select a subset of files to publish
6. Automatically attach metadata such as title, authors, and contributors to your deposition using information from a file in your repository
1. Choose which platform you want to draft your deposition on (Zenodo or Zenodo Sandbox), and easily switch between them (see input argument `sandbox`)
2. Choose to create your draft deposition as a new version in an existing collection, or as a new deposition in a new collection (see input argument `collection`)
3. Choose to finalize the deposition as part of the automation, or leave the deposition as draft for you to inspect and publish manually by clicking the button on Zenodo or Zenodo Sandbox (see input argument `publish`)
4. Publish a snapshot of the repository as a zip or tar.gz (see input argument `compression`)
5. Instead of publishing a snapshot, select a subset of files to publish (see input argument `filenames`)
6. Automatically attach metadata such as title, authors, and contributors to your deposition using information from a file in your repository (see input argument `metadata`)

## Example workflow

Expand Down Expand Up @@ -47,6 +47,7 @@ jobs:
| parameter name | default value | description |
| :-- | :-- | :-- |
| `collection` | `''` | By default, the draft is created as a new deposition in a new collection. Alternatively, you can have the new draft appear as a new version in a collection that you own on the target platform by assigning the collection identifier such as `1234567` to `collection`. You can find the collection identifier via Zenodo's frontend as the last part of the DOI listed under _Cite all versions?_ in the sidebar. |
| `compression` | `zip` | Which compression to use when making a snapshot of the entire repository (Valid options are `zip` or `tar.gz`; precludes use of argument `filenames`) |
| `filenames`| `''` | List of space-separated filenames that should be uploaded separately instead of the default behavior of uploading a snapshot of the entire repository as an archive (precludes use of argument compression). |
| `metadata` | `''` | Used to specify which repository file holds the metadata to be associated with the deposition. The metadata file should be a valid JSON file in Zenodo metadata format. |
| `publish` | `false` | Whether to automate finalizing the draft deposition as part of the automation, or to leave it to the user to click `Publish` manually after inspecting the draft deposition on the respective platform. |
Expand Down

0 comments on commit a971d60

Please sign in to comment.