chore: merge branch

mhucka · mhucka · commit 656acca6cb5e · 2023-11-08T18:44:19.000-08:00
diff --git a/.github/workflows/build-sphinx.yml b/.github/workflows/build-sphinx.yml
@@ -7,7 +7,7 @@
 # This workflow file was originally based on work by GitHub user "peaceiris":
 # https://github.com/peaceiris/actions-gh-pages
 
-name: Update docs on GitHub
+name: Build docs for gh-pages
 
 on:
   push:
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,5 +1,16 @@
 # Change log for IGA
 
+## Version 1.2.2 (2023-11-08)
+
+Changes in this release:
+* Fixed [issue #28](https://github.com/caltechlibrary/iga/issues/28): catch and report the case where a repo has no releases.
+* Fixed a bug that manifested when the GitHub access token was invalid.
+* Fixed a syntax bug in the Makefile.
+* Improved (hopefully) the caching of python dependencies to actually work this time.
+* Improved (hopefully) some of the diagnostic error messages.
+* Added Tom Morrell to the CITATION.cff file.
+
+
 ## Version 1.2.1 (2023-07-24)
 
 Changes in this release:
diff --git a/CITATION.cff b/CITATION.cff
@@ -7,6 +7,10 @@ authors:
     given-names: Michael
     affiliation: "Caltech Library"
     orcid: "https://orid.org/0000-0001-9105-5960"
+  - family-names: Morrell
+    given-names: Tom
+    affiliation: "Caltech Library"
+    orcid: "https://orcid.org/0000-0001-9266-5146"
 version: "1.2.1"
 date-released: "2023-07-24"
 doi: 10.22002/62htz-vpt80
diff --git a/Makefile b/Makefile
@@ -101,6 +101,8 @@ define instructions_text =
 11. Run $(color)make test-pypi$(reset).
 12. Check $(link)https://test.pypi.org/project/$(progname)$(reset)
 13. Run $(color)make pypi$(reset).
+14. Update the GitHub Marketplace version via the interface at
+    $(link)$(repo_url)/releases$(reset)
 endef
 
 
@@ -232,14 +234,15 @@ release-on-github: | update-all commit-updates
 	sleep 2
 	$(EDITOR) $(tmp_file)
 	gh release create $(tag) -t "Release $(version)" -F $(tmp_file)
+	gh release edit $(tag) --latest
 
 wait-on-iga:
 	@$(info ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓)
 	@$(info ┃ Wait for the archiving workflow to finish on GitHub ┃)
 	@$(info ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛)
 	sleep 2
 	$(eval pid := $(shell gh run list --workflow=iga.yml --limit 1 | tail -1 | awk -F $$'\t' '{print $$7}'))
-	$(shell gh run watch $(pid))
+	gh run watch $(pid)
 
 print-next-steps: vars
 	@$(info ┏━━━━━━━━━━━━┓)
diff --git a/action.yml b/action.yml
@@ -53,11 +53,19 @@ inputs:
     default: 'latest'
     required: false
     type: string
+
+  # The following input parameters are not exposed in the workflow recommended
+  # for users, but can be added by developers when desired.
   iga_copy:
     description: "(For developers only) Which copy of IGA to install."
     default: 'iga'
     required: false
     type: string
+  no_cache:
+    description: "(For developers only) Don't cache Python dependencies."
+    default: false
+    required: false
+    type: boolean
 
 runs:
   using: composite
@@ -76,6 +84,7 @@ runs:
         if [ "${{inputs.INVENIO_TOKEN}}" == '' ]; then
           echo "error='the value of INVENIO_TOKEN is not set.'" >> $GITHUB_ENV
         fi
+        echo python_packages_installed=false >> $GITHUB_ENV
 
     - name: Abort rest of workflow and report errors.
       uses: actions/github-script@v6
@@ -100,16 +109,18 @@ runs:
         python-version: "3.11.4"
 
     - name: Set up cache for Python dependencies.
-      uses: actions/cache@v3.2.4
+      uses: actions/cache@v3.3.1
       id: cache
       with:
         path: ${{ env.pythonLocation }}
         key: ${{ env.pythonLocation }}-${{ hashFiles('.git/iga-requirements.txt') }}
+        enableCrossOsArchive: true
 
     - name: Install IGA and dependencies if not found in cache.
-      if: steps.cache.outputs.cache-hit != 'true'
+      if: steps.cache.outputs.cache-hit != 'true' || inputs.no_cache == 'true'
       shell: bash
       run: |
+        echo python_packages_installed=true >> $GITHUB_ENV
         python -m pip install ${{inputs.iga_copy}}
 
     - name: Find out the latest release tag for this repo.
@@ -233,6 +244,14 @@ runs:
         fi
         echo "" >> $GITHUB_STEP_SUMMARY
         echo "This workflow ran $(iga --version | head -1 | sed s/iga/IGA/)." >> $GITHUB_STEP_SUMMARY
+        if [ "${{env.python_packages_installed}}" == 'true' ]; then
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo -n "_Note: This run of IGA took extra long because it" >> $GITHUB_STEP_SUMMARY
+          echo -n " had to install many Python packages and cache"    >> $GITHUB_STEP_SUMMARY
+          echo -n " them in GitHub's workflow framework. Future runs" >> $GITHUB_STEP_SUMMARY
+          echo -n " of IGA will not need to perform this step and"    >> $GITHUB_STEP_SUMMARY
+          echo    " the workflow should take much less time to run._" >> $GITHUB_STEP_SUMMARY
+        fi
 
 author: "Michael Hucka -- https://github.com/mhucka"
 branding:
diff --git a/codemeta.json b/codemeta.json
@@ -4,7 +4,7 @@
   "name": "InvenioRDM GitHub Archiver (IGA)",
   "identifier": "iga",
   "description": "The InvenioRDM GitHub Archiver (IGA) automatically archives GitHub releases in an InvenioRDM repository.",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "datePublished": "2023-07-24",
   "dateCreated": "2022-12-07",
   "author": [
diff --git a/docs/Makefile b/docs/Makefile
@@ -1,10 +1,8 @@
-# =============================================================================
 # @file    Makefile
 # @brief   Makefile for building docs using Sphinx and MyST
 # @created 2021-01-25
 # @license Please see the file named LICENSE in the project directory
 # @website https://github.com/caltechlibrary/iga
-# =============================================================================
 
 # Before we go any further, test if certain programs are available.
 # The following is based on the approach posted by Jonathan Ben-Avraham to
@@ -22,23 +20,27 @@ TEST := $(foreach p,$(PROGRAMS_NEEDED),\
 
 SPHINXOPTS  ?=
 SPHINXBUILD ?= sphinx-build
-SPHINXAUTO  = sphinx-autobuild
-SOURCEDIR   = .
-BUILDDIR    = _build
+SPHINXAUTO   = sphinx-autobuild
+SRCDIR	     = .
+BUILDDIR     = _build
 
 # Actions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 # Put it first so that "make" without argument is like "make help".
 help:
-	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@echo "Available commands:"
+	@echo "  auto	to watch source directory & rebuild docs if files change" |\
+	  expand -t 14
+	@$(SPHINXBUILD) -M help "$(SRCDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) |\
+	  egrep -v '^Sphinx|Please' | sort | expand -t 20
 
 auto autobuild live livehtml:
-	@$(SPHINXAUTO) "$(SOURCEDIR)" "$(BUILDDIR)"/html $(SPHINXOPTS) $(O)
+	@$(SPHINXAUTO) "$(SRCDIR)" "$(BUILDDIR)"/html $(SPHINXOPTS) $(O)
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@$(SPHINXBUILD) -M $@ "$(SRCDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 
 # Cleanup and miscellaneous directives ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/docs/index.md b/docs/index.md
@@ -1,8 +1,8 @@
 # InvenioRDM GitHub Archiver<img width="50em" align="right" style="display: block; margin: auto auto 2em 2em"  src="_static/media/cloud-upload.svg">
 
-[InvenioRDM](https://inveniosoftware.org/products/rdm/) is the basis for many institutional repositories such as [CaltechDATA](https://data.caltech.edu) that enable users to preserve software and data sets in long-term archive. Though such repositories are critical resources, creating detailed records and uploading assets can be a tedious and error-prone process if done manually. This is where the [_InvenioRDM GitHub Archiver_](https://github.com/caltechlibrary/iga) (IGA) comes in.
+[InvenioRDM](https://inveniosoftware.org/products/rdm/) is used by many institutional repositories such as [CaltechDATA](https://data.caltech.edu) to let users preserve software and data in a long-term archive managed by their institution. Depositing software and/or data into these repositories requires the creation of detailed metadata records &ndash; a tedious and error-prone process if done manually. This is where the [_InvenioRDM GitHub Archiver_](https://github.com/caltechlibrary/iga) (IGA) comes in.
 
-IGA creates metadata records and sends releases from GitHub to an InvenioRDM-based repository server. IGA can be invoked from the command line; it also can be set up as a [GitHub Action](https://docs.github.com/en/actions) to archive GitHub releases automatically for a repository each time they are made.
+IGA can create metadata records and send releases from GitHub to an InvenioRDM-based repository server. It can be run as a command line program; it also can be set up as a [GitHub Action](https://docs.github.com/en/actions) to archive GitHub releases in InvenioRDM automatically each time they are made.
 
 <figure>
 <img align="middle" src="_static/media/example-github-release.jpg" width="40%">
diff --git a/docs/introduction.md b/docs/introduction.md
@@ -1,10 +1,10 @@
 # Introduction
 
-[InvenioRDM](https://inveniosoftware.org/products/rdm/) is a research data management (RDM) repository platform based on the [Invenio Framework](https://inveniosoftware.org/products/framework/) and [Zenodo](https://www.zenodo.org). At institutions like Caltech, InvenioRDM is used as the basis for institutional repositories such as [CaltechDATA](https://data.caltech.edu). Of particular interest to software developers is that a repository like [CaltechDATA](https://data.caltech.edu) offers the means to preserve software projects in a long-term archive managed by their institution. Here is a screenshot of an example software project release archived in [CaltechDATA](https://data.caltech.edu):
+[InvenioRDM](https://inveniosoftware.org/products/rdm/) is a research data management (RDM) repository platform based on the [Invenio Framework](https://inveniosoftware.org/products/framework/) and [Zenodo](https://www.zenodo.org). At institutions like Caltech, InvenioRDM is used as the basis for institutional repositories such as [CaltechDATA](https://data.caltech.edu). It offers the means to preserve software and data projects in a long-term archive managed by their institution.
 
 <figure>
     <img src="_static/media/example-record-landing-page.jpg" width="80%">
-    <figcaption>Example of a landing page for a record in CaltechDATA.</figcaption>
+    <figcaption>Screenshot of a landing page for a record in <a href="https://data.caltech.edu">CaltechDATA</a>. The source code for version 1.3.5 of the software project <a href="https://data.caltech.edu/records/fqmae-krq60">eprints2archives</a> has been archived in the repository, and this example shows some of the metadata associated with that archived copy.</figcaption>
 </figure>
 
 The metadata contained in the record of a deposit is critical to making the record widely discoverable by other people, but it can be tedious and error-prone to enter the metadata by hand.  This is where automation such as IGA come in: _IGA can save users the trouble of depositing software and filling out the metadata record in InvenioRDM by performing all the steps automatically._
@@ -50,12 +50,12 @@ IGA looks for `codemeta.json` and `CITATION.cff` files in a repository and uses
 
 ## Using IGA
 
-IGA makes it easy to archive any release from GitHub into an InvenioRDM server. Once you have a personal access token ([PAT](glossary.md#term-PAT)) for InvenioRDM (and optionally for GitHub too) and have set the environment variable `INVENIO_TOKEN` (and optionally `GITHUB_TOKEN`), you can archive a GitHub release as easily as in this example:
+IGA makes it easy to archive any release from GitHub into an InvenioRDM server. Once you have a personal access token ([PAT](glossary.md#term-PAT)) for InvenioRDM (and optionally, one for GitHub too) and have set the environment variable `INVENIO_TOKEN` (and optionally `GITHUB_TOKEN`), you can archive a GitHub release as easily as in this example:
 ```shell
 iga -s data.caltech.edu https://github.com/mhucka/taupe/releases/tag/v1.2.0
 ```
 IGA will contact GitHub, extract metadata from the release and the repository, construct a metadata record in the format required by InvenioRDM, and send the record plus the GitHub release source archive (a [ZIP](https://en.wikipedia.org/wiki/ZIP_(file_format)) file) to the InvenioRDM server. Various options can modify IGA's behavior, as explained in detail in the section on [command-line usage of IGA](cli-usage.md).
 
-Note that the availability of a command-line version of IGA means you can also use it to send _past_ releases to an InvenioRDM server &ndash; IGA doesn't care if what you're asking it to archive is the _latest_ release of something; it can archive any release. This makes it useful for archiving past projects; it also makes it possible for institutions to easily perform activities such as archiving software on behalf of faculty and students.
+Note that the availability of a command-line version of IGA means you can also use it to send _past_ GitHub releases to an InvenioRDM server &ndash; IGA doesn't care if what you're asking it to archive is the _latest_ release of something; it can archive any release. This makes it useful for archiving past projects; it also makes it possible for institutions to easily perform activities such as archiving software on behalf of faculty and students.
 
 As a GitHub Action, IGA allows you to set up a GitHub workflow that will automatically send new releases to a designated InvenioRDM server. The procedure for this is detailed in the section on [GitHub Action usage of IGA](gha-usage.md). Once set up, you do not have to remember to send releases of a particular GitHub project to InvenioRDM &ndash; it will do it for you.
diff --git a/docs/quick-start.md b/docs/quick-start.md
@@ -34,7 +34,7 @@ flowchart TD;
 4. On the page that is shown after you click that button, name your token (the name does not matter) and click the <kbd>Create</kbd> button<figure><img src="_static/media/new-pat.png" width="50%"></figure>
 5. After InvenioRDM creates and shows you the token, **copy it to a safe location** because InvenioRDM will not show it again
 
-## Configuring a local IGA
+## Configuring IGA for local use
 
 To send a GitHub release to your InvenioRDM server, IGA needs this information:
 1. (Required) The identity of the GitHub release to be archived
@@ -49,7 +49,7 @@ export INVENIO_TOKEN=qKLoOH0KYf4D98PGYQGnC09hiuqw3Y1SZllYnonRVzGJbWz2
 export GITHUB_TOKEN=ghp_wQXp6sy3AsKyyEo4l9esHNxOdo6T34Zsthz
 ```
 
-Once these are set, use of IGA can be as simple as providing a URL for a release in GitHub. For example, the following command creates a draft record (the `-d` option is short for `--draft`) for another project in GitHub and tells IGA to open (the `-o` option is short for `--open`) the newly-created InvenioRDM entry in a web browser:
+Once these are set, use of IGA can be as simple as providing a URL for a release in GitHub. For example, the following command creates a draft record (the `-d` option is short for `--draft`) for a certain project in GitHub and tells IGA to open (the `-o` option is short for `--open`) the newly-created InvenioRDM entry in a web browser:
 ```shell
 iga -d -o https://github.com/mhucka/taupe/releases/tag/v1.2.0
 ```
diff --git a/docs/tips.md b/docs/tips.md
diff --git a/iga/cli.py b/iga/cli.py
diff --git a/iga/github.py b/iga/github.py
diff --git a/tests/test_cli.py b/tests/test_cli.py
diff --git a/tests/test_record_from_codemeta.py b/tests/test_record_from_codemeta.py
