Skip to content

Commit

Permalink
fix: various Markdown lint issues
Browse files Browse the repository at this point in the history
  • Loading branch information
mhucka committed Nov 20, 2023
1 parent 591f528 commit aef25b2
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
## 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.
Expand All @@ -14,6 +15,7 @@ Changes in this release:
## Version 1.2.1 (2023-07-24)

Changes in this release:

* Fixed `setup.cfg`, which had some garbled content.
* Fixed the GitHub Action for building the IGA documentation pages to avoid needlessly running it on every push.
* The GitHub Actions workflow (`action.yml`) for IGA now caches Python package dependencies for a slight speed up in run times on GitHub.
Expand All @@ -25,6 +27,7 @@ Changes in this release:
This version fixes problems with handling Invenio Communities. First, an internal bug in IGA would cause an exception if the user attempted to list communities in an InvenioRDM server that defined more than one community. Second, a bug in InvenioRDM itself meant that community links were broken. (Thanks to @tmorrell for a fix via PR #23.)

Additional changes in this version:

* Switched to using `codemeta.json` as the main source of truth for version info. The `setup.cfg` file is now updated from `codemeta.json`, not the other way around.
* With respect to how the InvenioRDM metadata field `related_identifiers` is handled, the IGA [documentation](https://caltechlibrary.github.io/iga/appendix.html#record-metadata) and the [Google spreadsheet describing how IGA maps fields](https://docs.google.com/spreadsheets/d/1QgFrZIhip1qKA_M45QkeYe9SH238XL1K/edit?usp=sharing&ouid=111701691832013929970&rtpof=true&sd=true) both omitted the use of CodeMeta fields `downloadUrl` and `installUrl` and CFF field `repository-artifact`. These fields are now in the documentation.
* The Makefile has been updated in various ways based on experiences with other projects.
Expand All @@ -33,9 +36,11 @@ Additional changes in this version:
## Version 1.1.0 (2023-05-31)

New features:

* New option `--print-doi` makes IGA print the DOI of a published record in addition to printing the URL. (Without the option, IGA only prints the URL.)

Changes:

* The color of text messages printed to the terminal has been changed slightly in an effort to improve readability.
* The versions of some dependencies in `requirements.txt` have been updated.
* Documentation has been updated and expanded.
Expand All @@ -44,18 +49,21 @@ Changes:
## Version 1.0.3 (2023-05-24)

Changes in this release:

* The sample workflow has been revised to be slightly more informative about where it's sending the release for archiving.


## Version 1.0.2 (2023-05-23)

Changes in this release:

* Fix issue #21: the copyright year put in the metadata `dates` field can could up being a completely bogus value in some cases.


## Version 1.0.1 (2023-05-22)

Changes in this release:

* Fix issue #8: org parsing some results in error.


Expand All @@ -67,6 +75,7 @@ This is the first full release of IGA, the _InvenioRDM GitHub Archiver_. This re
## Version 0.0.16 (2023-05-17)

Changes in this release:

* Fixed another problem with logging, in part by reverting a previous change but also by modifying the code that writes error messages.
* Expanded the error catches in the GitHub Action workflow to detect and report problems with invalid tokens.
* Merge PR #7: doc improvements.
Expand All @@ -75,18 +84,21 @@ Changes in this release:
## Version 0.0.15 (2023-05-17)

Changes in this version:

* IGA now tests the InvenioRDM token explicitly and returns a new exit code if the token is rejected. This makes it possible for the GitHub Action to report this situation more clearly.


## Version 0.0.14 (2023-05-16)

Changes in this release:

* Fixed bug where setting `verbose` mode or higher caused output to go to the terminal and was not properly sent to the log destination.


## Version 0.0.13 (2023-05-16)

Changes in this release:

* IGA detects the case where InvenioRDM refuses the token, and reports the error more explicitly.
* More documentation updates.
* Fixes to test cases.
Expand All @@ -95,13 +107,15 @@ Changes in this release:
## Version 0.0.12 (2023-05-12)

Changes in this release:

* A preliminary GitHub Action workflow is available.
* Documentation is more complete.


## Version 0.0.11 (2023-05-10)

Changes in this release:

* Fixed behavior of `--mode quiet`: it was not completely quiet after all, but now it is.
* Fixed behavior when `--log-dest` is used; not all output was going to the log destination, but now it is.
* Fixed additional minor issues.
Expand All @@ -110,6 +124,7 @@ Changes in this release:
## Version 0.0.10 (2023-05-09)

Changes in this release:

* IGA won't fail if the GitHub release description is empty and the repo doesn't have a `codemeta.json` nor a `CITATION.cff` file.
* IGA won't fail if the GitHub repo doesn't have a license and there are no `codemeta.json` or `CITATION.cff` files.
* IGA will properly get release assets from private repos (assuming the user has access to the private repo). Previously, it would erroneously think the repo had no assets.
Expand All @@ -118,6 +133,7 @@ Changes in this release:
## Version 0.0.9 (2023-05-08)

Changes in this release:

* `IGA` and `GitHub` are now added automatically to the list of subject tags in the InvenioRDM record created by IGA.
* Debug mode will not cause `pdb` to be invoked upon an exception if IGA is running as a GitHub Action.
* Documentation has been further expanded and improved.
Expand Down Expand Up @@ -148,6 +164,7 @@ This release fixes some bugs and adds a few more features.
This release fixes some bugs and adds a few more features.

### What's new

Check failure on line 166 in CHANGES.md

View workflow job for this annotation

GitHub Actions / lint

Multiple headings with the same content

CHANGES.md:166 MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "### What's new"] https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md024.md

* CodeMeta's `downloadUrl` and `installUrl` as well as CITATION.cff's `repository-artifact` fields are now supported.
* A new repository branch `develop` is where new development now takes place on GitHub. Previously, the lazy repository maintainer didn't create a branch and instead worked out of `main`.

Expand Down Expand Up @@ -184,6 +201,7 @@ This release fixes a problem with the syntax of `setup.py` that prevented instal
## Version 0.0.2 (2023-04-06)

Fixes:

* Fix issue #1: error if `--mode` option is not given.
* Fix missing dependencies in `requirements-dev.txt`.
* Fix parsing of https dependencies in `setup.py`.
Expand All @@ -193,6 +211,7 @@ Fixes:
* Fix tests that had gotten out of sync with the codebase.

Changes:

* (Hopefully) improve colors and readability of help text printed with `--help`.
* More documentation (still a work in progress).

Expand Down

0 comments on commit aef25b2

Please sign in to comment.