Fix missing command arguments (#17)

* add title and description support + do not override related_identifiers if some exists
* fix invalid format args
* pass down title/description to command
* add quotes around action parameters
* undo quotes for zenodo json param
* undo quotes for doi param
* provide '--description-file' alternative parameter for zenodo record description
* add missing 'description_file' forwarding
* replace single quotes by escaped double quotes to avoid unresolved file path with literal quote in string parameter + use argparse.FileType to raise unresolved file immediately

* adjust commands to avoid weird literal single/double quotes parsing

Author: fmigneault

action.yml

@@ -19,7 +19,9 @@ inputs:
   title:
     description: zenodo title (optional)
   description:
-    description: zenodo description (optional)
+    description: zenodo description as plain text (optional)
+  description_file:
+    description: zenodo description from a file (optional)
 
 outputs:
   badge:
@@ -64,18 +66,29 @@ runs:
         ACTION_PATH: ${{ github.action_path }}
         ZENODO_TOKEN: ${{ inputs.token }}
         doi: ${{ inputs.doi }}
+        title: ${{ inputs.title }}
+        description: ${{ inputs.description }}
+        description_file: ${{ inputs.description_file }}
       run: |
-        command="python ${{ github.action_path }}/scripts/deploy.py upload ${archive} --version ${version}"
-        if [[ "${doi}" != "" ]]; then
-            command="$command --doi ${doi}"
+        command=("python" "${{ github.action_path }}/scripts/deploy.py" "upload" "${archive}" "--version" "${version}")
+        if [[ -n "${doi}" ]]; then
+            command+=("--doi" "${doi}")
         fi
-        if [[ "${zenodo_json}" != "" ]]; then
-            command="$command --zenodo-json ${zenodo_json}"
+        if [[ -n "${title}" ]]; then
+            command+=("--title" "${title}")
         fi
-        if [[ "${html_url}" != "" ]]; then
-            command="$command --html-url ${html_url}"
+        if [[ -n "${description}" ]]; then
+            command+=("--description" "${description}")
+        elif [[ -n "${description_file}" ]]; then
+            command+=("--description-file" "${description_file}")
         fi
-        printf "$command\n"
-        $command
+        if [[ -n "${zenodo_json}" ]]; then
+            command+=("--zenodo-json" "${zenodo_json}")
+        fi
+        if [[ -n "${html_url}" ]]; then
+            command+=("--html-url" "${html_url}")
+        fi
+        printf "%s " "${command[@]}"
+        "${command[@]}"
 
       shell: bash

scripts/deploy.py

@@ -12,9 +12,14 @@
 import sys
 from datetime import datetime
 from glob import glob
+from typing import TYPE_CHECKING
 
 import requests
 
+if TYPE_CHECKING:
+    import io
+    from typing import Any, Dict, Optional
+
 
 def read_file(filename):
     with open(filename, "r") as fd:
@@ -208,7 +213,16 @@ def publish(self, data):
         for k, v in published["links"].items():
             set_env_and_output(k, v)
 
-    def upload_metadata(self, upload, zenodo_json, version, html_url=None, title=None, description=None):
+    def upload_metadata(
+        self,
+        upload,                 # type: Dict[str, Any]
+        zenodo_json,            # type: str
+        version,                # type: str
+        html_url=None,          # type: Optional[str]
+        title=None,             # type: Optional[str]
+        description=None,       # type: Optional[str]
+        description_file=None,  # type: Optional[io.TextIOBase]
+    ):                          # type: (...) -> Dict[str, Any]
         """
         Given an upload response and zenodo json, upload new data
 
@@ -244,6 +258,8 @@ def upload_metadata(self, upload, zenodo_json, version, html_url=None, title=Non
 
         if description is not None:
             metadata["description"] = description
+        elif description_file:
+            metadata["description"] = description_file.read()
 
         # Make the deposit!
         url = "https://zenodo.org/api/deposit/depositions/%s" % upload["id"]
@@ -261,7 +277,15 @@ def upload_metadata(self, upload, zenodo_json, version, html_url=None, title=Non
 
 
 def upload_archive(
-    archive, version, html_url=None, zenodo_json=None, doi=None, sandbox=False, title=None, description=None,
+    archive,
+    version,
+    html_url=None,
+    zenodo_json=None,
+    doi=None,
+    sandbox=False,
+    title=None,
+    description=None,
+    description_file=None,
 ):
     """
     Upload an archive to an existing Zenodo "versions DOI"
@@ -284,7 +308,15 @@ def upload_archive(
         cli.upload_archive(upload, path)
 
     # Finally, load .zenodo.json and add version
-    data = cli.upload_metadata(upload, zenodo_json, version, html_url, title=title, description=description)
+    data = cli.upload_metadata(
+        upload,
+        zenodo_json,
+        version,
+        html_url,
+        title=title,
+        description=description,
+        description_file=description_file,
+    )
 
     # Finally, publish
     cli.publish(data)
@@ -307,7 +339,16 @@ def get_parser():
     )
     upload.add_argument("--version", help="version to upload")
     upload.add_argument("--title", help="Title to override in upload")
-    upload.add_argument("--description", help="Description to override in upload (allows HTML)")
+    upload_desc = upload.add_mutually_exclusive_group()
+    upload_desc.add_argument(
+        "--description",
+        help="Description to override in upload as plain text (allows HTML, but be careful about escaping)",
+    )
+    upload_desc.add_argument(
+        "--description-file",
+        help="Description to override in upload from a file.",
+        type=argparse.FileType("r", encoding="utf-8"),
+    )
     upload.add_argument("--doi", help="an existing DOI to add a new version to")
     upload.add_argument(
         "--html-url", dest="html_url", help="url to use for the release"
@@ -343,6 +384,7 @@ def help(return_code=0):
             html_url=args.html_url,
             title=args.title,
             description=args.description,
+            description_file=args.description_file,
         )
 
     # We should not get here :)