Release/1.9.0

.github/dependabot.yml

@@ -8,15 +8,15 @@ updates:
   - package-ecosystem: pip
     directory: "/"
     schedule:
-      interval: weekly
+      interval: "monthly"
     # Raise pull requests for version updates
     # to pip against the `develop` branch
     target-branch: "develop"
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
       # Check for updates to GitHub Actions every week
-      interval: "weekly"
+      interval: "monthly"
     # Raise pull requests for version updates
     # to pip against the `develop` branch
     target-branch: "develop"

.github/workflows/build-pipeline.yml

@@ -12,6 +12,8 @@ on:
 jobs:
   run_tests:
     uses: ./.github/workflows/reusable_run_tests.yml
+    secrets:
+      codecov_token: ${{ secrets.CODECOV_TOKEN }}
 
   bump_version:
     needs: run_tests

.github/workflows/pull-request-received.yml

@@ -8,5 +8,7 @@ on:
     branches: [ feature/**, issue/**, issues/** ]
 
 jobs:
-  build_and_test:
+  run_test:
     uses: ./.github/workflows/reusable_run_tests.yml
+    secrets:
+      codecov_token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/reusable_run_tests.yml

@@ -7,6 +7,9 @@ name: A reusable workflow to build and run the unit test suite
 
 on:
   workflow_call:
+    secrets:
+      codecov_token:
+        required: true
   workflow_dispatch:
 
 jobs:
@@ -39,9 +42,10 @@ jobs:
 
       - name: Run tests with coverage
         run: |
-          poetry run pytest --cov=ncompare --cov-report=xml:build/reports/coverage${{ matrix.python-version }}.xml --cov-report=html:build/reports/coverage${{ matrix.python-version }}.html --cov-report= tests/
+          poetry run pytest --cov=ncompare --cov-report=xml:build/reports/coverage${{ matrix.python-version }}.xml
 
       - name: Upload coverage reports to Codecov
         uses: codecov/codecov-action@v4
-        env:
-          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          verbose: true

.pre-commit-config.yaml

@@ -3,13 +3,13 @@ default_language_version:
 
 repos:
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.15.1
+    rev: v3.15.2
     hooks:
       - id: pyupgrade
         args: [ "--py39-plus" ]
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v4.6.0
     hooks:
       - id: trailing-whitespace
         exclude: ".txt"
@@ -24,18 +24,24 @@ repos:
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
-    rev: 'v0.3.2'
+    rev: 'v0.4.6'
     hooks:
       - id: ruff
         args: [ "--fix" ]
 
   # https://github.com/python/black#version-control-integration
   - repo: https://github.com/psf/black
-    rev: 24.2.0
+    rev: 24.4.2
     hooks:
       - id: black-jupyter
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.9.0
+    rev: v1.10.0
     hooks:
       - id: mypy
+
+# TODO: Reconsider using the alexjs hook when there is a way to ignore particular warnings and/or files.
+#  - repo: "https://github.com/mfisher87/alexjs-pre-commit-mirror"
+#    rev: "v11.0.1"  # Use the sha / tag you prefer
+#    hooks:
+#      - id: "alex"

CHANGELOG.md

@@ -4,7 +4,21 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [1.8.0]
+## [1.9.0]
+### Added
+- [Issue #210](https://github.com/nasa/ncompare/issues/210): Add gif of usage to readme
+### Changed
+- [Issue #184](https://github.com/nasa/ncompare/issues/184): Change license to Apache License 2.0. and include copyright header text
+- [Issue #200](https://github.com/nasa/ncompare/issues/200): Change dependabot frequency to monthly
+### Deprecated
+### Removed
+### Fixed
+- [Issue #208](https://github.com/nasa/ncompare/issues/208): Fix missing group error
+- [Pull #190](https://github.com/nasa/ncompare/pull/190): Fix codecov upload token error
+- [Pull #199](https://github.com/nasa/ncompare/pull/199): Resolve linting error
+### Security
+
+## [1.8.0] - 2024-03-12
 ### Added
 ### Changed
 - update dependencies
@@ -15,7 +29,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 ### Security
 
-## [1.7.3]
+## [1.7.3] - 2024-02-06
 ### Added
 ### Changed
 - add Zenodo badge to readme
@@ -24,7 +38,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 ### Security
 
-## [1.7.2]
+## [1.7.2] - 2024-02-06
 ### Added
 ### Changed
 - add pyOpenSci badge to readme
@@ -33,7 +47,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 ### Security
 
-## [1.7.1]
+## [1.7.1] - 2024-02-06
 ### Added
 ### Changed
 - update dependencies
@@ -43,7 +57,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 ### Security
 
-## [1.7.0]
+## [1.7.0] - 2024-02-06
 ### Added
 ### Changed
 - [pull/136](https://github.com/nasa/ncompare/pull/136): Replace data in example notebook with those requiring no credentials
@@ -53,7 +67,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - [pull/135](https://github.com/nasa/ncompare/pull/135): Fix links in readme
 ### Security
 
-## [1.6.2]
+## [1.6.2] - 2024-01-16
 ### Added
 ### Changed
 - updated PyPI classifiers in pyproject.toml
@@ -62,7 +76,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 ### Security
 
-## [1.6.1]
+## [1.6.1] - 2024-01-16
 ### Added
 ### Changed
 ### Deprecated
@@ -72,7 +86,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Security
 - [pull-request/125](https://github.com/nasa/ncompare/pull/125): Bump jinja2 from 3.1.2 to 3.1.3
 
-## [1.6.0]
+## [1.6.0] - 2024-01-16
 ### Added
 - [pull-request/79](https://github.com/nasa/ncompare/pull/79): Add option to only display variables and attributes that are different
 - [pull-request/100](https://github.com/nasa/ncompare/pull/100): Add version to cli
@@ -93,7 +107,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Updated out-dated example snippet in README
 ### Security
 
-## [1.5.0]
+## [1.5.0] - 2023-10-25
 ### Added
 - [pull-request/63](https://github.com/nasa/ncompare/pull/59): Add a tutorial example notebook.
 - Added a simple GitHub Pages that links to an quarto-produced version of the tutorial notebook.
@@ -103,7 +117,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 ### Security
 
-## [1.4.0]
+## [1.4.0] - 2023-10-23
 ### Added
 - [pull-request/59](https://github.com/nasa/ncompare/pull/59): Add the ability to modify the width of each column in the comparison table.
 ### Changed
@@ -113,7 +127,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - [pull-request/60](https://github.com/nasa/ncompare/pull/60): Removes an extra line of printed filepaths.
 ### Security
 
-## [1.3.0]
+## [1.3.0] - 2023-10-20
 ### Added
 ### Changed
 ### Deprecated
@@ -122,7 +136,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - [pull-request/55](https://github.com/nasa/ncompare/pull/55): Fix variable value matching
 ### Security
 
-## [1.2.0]
+## [1.2.0] - 2023-10-11
 ### Added
 - [pull-request/44](https://github.com/nasa/ncompare/pull/44): Added issue templates and markdown guides for CONTRIBUTING and the CODE_OF_CONDUCT
 ### Changed
@@ -132,7 +146,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 ### Security
 
-## [1.1.0]
+## [1.1.0] - 2023-09-26
 ### Added
 - [commit/4b98808](https://github.com/nasa/ncompare/commit/4b98808cf3d8424da25a226687d304ce7d46738e): Set up dependabot for automated version updates
 ### Changed
@@ -142,23 +156,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 ### Security
 
-## [1.0.2]
+## [1.0.2] - 2023-09-20
 ### Added
-- [issue/19](https://github.com/nasa/ncompare/issues/19): Add automated publishing (via poetry) to TestPyPI and PyPI in Actions workflow
+- Add automated publishing (via poetry) to TestPyPI and PyPI in Actions workflow [issue/19](https://github.com/nasa/ncompare/issues/19)
 ### Changed
-- [issue/23](https://github.com/nasa/ncompare/issues/23): Use ruff and black for linting and formatting
+- Use ruff and black for linting and formatting [issue/23](https://github.com/nasa/ncompare/issues/23)
 ### Deprecated
 ### Removed
 ### Fixed
 ### Security
 
-## [1.0.1]
+## [1.0.1] - 2023-09-06
 ### Added
 ### Changed
-- [issue/12](https://github.com/nasa/ncompare/issues/12): Improve test suite
-- [issue/13](https://github.com/nasa/ncompare/issues/13): Enable `ncompare` to work with greater group depths
+- Improve test suite [#12](https://github.com/nasa/ncompare/issues/12):
+- Enable `ncompare` to work with greater group depths [#13](https://github.com/nasa/ncompare/issues/13):
 ### Deprecated
 ### Removed
 ### Fixed
-- [issue/5](https://github.com/nasa/ncompare/issues/5): Fix author attribute for poetry
+- Fix author attribute for poetry [#5](https://github.com/nasa/ncompare/issues/5)
 ### Security

CITATION.cff

@@ -18,8 +18,8 @@ keywords:
 url: "https://ncompare.readthedocs.io"
 repository-code: "https://github.com/nasa/ncompare"
 
-version: 1.8.0
-date-released: 2024-02-06
+version: 1.9.0
+date-released: 2024-05-29
 
 authors:
 - family-names: "Baskin"