Merge pull request #151 from michalis1/release-1.0.2

Release 1.0.2

Author: jeffkala

.cookiecutter.json

@@ -0,0 +1,30 @@
+{
+    "cookiecutter": {
+        "codeowner_github_usernames": "@lvrfrc87 @scetron @grelleum @jeffkala @pszulczewski",
+        "full_name": "Network to Code, LLC",
+        "email": "info@networktocode.com",
+        "github_org": "networktocode",
+        "description": "Python library for examining structured data.",
+        "project_name": "jdiff",
+        "project_slug": "jdiff",
+        "repo_url": "https://github.com/networktocode/jdiff",
+        "base_url": "jdiff",
+        "project_python_name": "jdiff",
+        "project_python_base_version": "3.10",
+        "project_with_config_settings": "no",
+        "generate_docs": "yes",
+        "version": "1.0.1",
+        "original_publish_year": "2022",
+        "_drift_manager": {
+            "template": "https://github.com/networktocode-llc/cookiecutter-ntc.git",
+            "template_dir": "python",
+            "template_ref": "main",
+            "cookie_dir": "",
+            "pull_request_strategy": "update-or-create",
+            "post_actions": [],
+            "draft": false,
+            "baked_commit_ref": "bc931311336d391d878202dba239389783ee9f09",
+            "drift_managed_branch": "develop"
+        }
+    }
+}

.github/ISSUE_TEMPLATE/bug_report.md

@@ -4,7 +4,7 @@ about: Report a reproducible bug in the current release of jdiff
 ---
 
 ### Environment
-* Python version:  <!-- Example: 3.11.2 -->
+* Python version:  <!-- Example: 3.10 -->
 * jdiff version:  <!-- Example: 1.0.0 -->
 
 <!-- What did you expect to happen? -->

.github/workflows/ci.yml

@@ -8,8 +8,6 @@ on:  # yamllint disable-line rule:truthy rule:comments
     branches:
       - "main"
       - "develop"
-    tags:
-      - "v*"
   pull_request: ~
 
 env:
@@ -18,7 +16,7 @@ env:
 
 jobs:
   ruff-format:
-    runs-on: "ubuntu-24.04"
+    runs-on: "ubuntu-latest"
     env:
       INVOKE_JDIFF_LOCAL: "True"
     steps:
@@ -27,11 +25,11 @@ jobs:
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
         with:
-          poetry-version: "1.8.5"
+          poetry-version: "2.1.3"
       - name: "Linting: ruff format"
         run: "poetry run invoke ruff --action format"
   ruff-lint:
-    runs-on: "ubuntu-24.04"
+    runs-on: "ubuntu-latest"
     env:
       INVOKE_JDIFF_LOCAL: "True"
     steps:
@@ -40,11 +38,11 @@ jobs:
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
         with:
-          poetry-version: "1.8.5"
+          poetry-version: "2.1.3"
       - name: "Linting: ruff"
         run: "poetry run invoke ruff --action lint"
   check-docs-build:
-    runs-on: "ubuntu-22.04"
+    runs-on: "ubuntu-latest"
     env:
       INVOKE_JDIFF_LOCAL: "True"
     steps:
@@ -53,11 +51,12 @@ jobs:
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
         with:
-          poetry-version: "1.8.5"
+          poetry-version: "2.1.3"
+          poetry-install-options: "--only dev,docs"
       - name: "Check Docs Build"
         run: "poetry run invoke build-and-check-docs"
   poetry:
-    runs-on: "ubuntu-24.04"
+    runs-on: "ubuntu-latest"
     env:
       INVOKE_JDIFF_LOCAL: "True"
     steps:
@@ -66,15 +65,11 @@ jobs:
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
         with:
-          poetry-version: "1.8.5"
+          poetry-version: "2.1.3"
       - name: "Checking: poetry lock file"
-        run: "poetry lock --check"
-    needs:
-      - "ruff-format"
-      - "ruff-lint"
-      - "yamllint"
+        run: "poetry run invoke lock --check"
   yamllint:
-    runs-on: "ubuntu-24.04"
+    runs-on: "ubuntu-latest"
     env:
       INVOKE_JDIFF_LOCAL: "True"
     steps:
@@ -83,25 +78,29 @@ jobs:
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
         with:
-          poetry-version: "1.8.5"
+          poetry-version: "2.1.3"
       - name: "Linting: yamllint"
         run: "poetry run invoke yamllint"
+  check-in-docker:
     needs:
       - "ruff-format"
       - "ruff-lint"
-  pylint:
-    runs-on: "ubuntu-24.04"
+      - "poetry"
+      - "yamllint"
+    runs-on: "ubuntu-latest"
     strategy:
       fail-fast: true
       matrix:
-        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+        python-version: ["3.10", "3.13"]
     env:
-      PYTHON_VER: "${{ matrix.python-version }}"
+      INVOKE_JDIFF_PYTHON_VER: "${{ matrix.python-version }}"
     steps:
       - name: "Check out repository code"
         uses: "actions/checkout@v4"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
+        with:
+          poetry-version: "2.1.3"
       - name: "Get image version"
         run: "echo INVOKE_JDIFF_IMAGE_VER=`poetry version -s`-py${{ matrix.python-version }} >> $GITHUB_ENV"
       - name: "Set up Docker Buildx"
@@ -119,26 +118,26 @@ jobs:
           cache-from: "type=gha,scope=${{ env.INVOKE_JDIFF_IMAGE_NAME }}-${{ env.INVOKE_JDIFF_IMAGE_VER }}-py${{ matrix.python-version }}"
           cache-to: "type=gha,scope=${{ env.INVOKE_JDIFF_IMAGE_NAME }}-${{ env.INVOKE_JDIFF_IMAGE_VER }}-py${{ matrix.python-version }}"
           build-args: |
-            PYTHON_VER=${{ env.PYTHON_VER }}
-      - name: "Debug: Show docker images"
-        run: "docker image ls"
+            PYTHON_VER=${{ matrix.python-version }}
       - name: "Linting: Pylint"
         run: "poetry run invoke pylint"
-    needs:
-      - "poetry"
   pytest:
+    needs:
+      - "check-in-docker"
     strategy:
       fail-fast: true
       matrix:
-        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
-    runs-on: "ubuntu-24.04"
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    runs-on: "ubuntu-latest"
     env:
-      PYTHON_VER: "${{ matrix.python-version }}"
+      INVOKE_JDIFF_PYTHON_VER: "${{ matrix.python-version }}"
     steps:
       - name: "Check out repository code"
         uses: "actions/checkout@v4"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
+        with:
+          poetry-version: "2.1.3"
       - name: "Get image version"
         run: "echo INVOKE_JDIFF_IMAGE_VER=`poetry version -s`-py${{ matrix.python-version }} >> $GITHUB_ENV"
       - name: "Set up Docker Buildx"
@@ -156,18 +155,14 @@ jobs:
           cache-from: "type=gha,scope=${{ env.INVOKE_JDIFF_IMAGE_NAME }}-${{ env.INVOKE_JDIFF_IMAGE_VER }}-py${{ matrix.python-version }}"
           cache-to: "type=gha,scope=${{ env.INVOKE_JDIFF_IMAGE_NAME }}-${{ env.INVOKE_JDIFF_IMAGE_VER }}-py${{ matrix.python-version }}"
           build-args: |
-            PYTHON_VER=${{ env.PYTHON_VER }}
-      - name: "Debug: Show docker images"
-        run: "docker image ls"
+            PYTHON_VER=${{ matrix.python-version }}
       - name: "Run Tests"
         run: "poetry run invoke pytest"
-    needs:
-      - "poetry"
   changelog:
     if: >
       contains(fromJson('["develop"]'), github.base_ref) &&
       (github.head_ref != 'main') && (!startsWith(github.head_ref, 'release'))
-    runs-on: "ubuntu-22.04"
+    runs-on: "ubuntu-latest"
     steps:
       - name: "Check out repository code"
         uses: "actions/checkout@v4"
@@ -176,98 +171,8 @@ jobs:
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
         with:
-          poetry-version: "1.8.5"
+          poetry-version: "2.1.3"
       - name: "Check for changelog entry"
         run: |
           git fetch --no-tags origin +refs/heads/${{ github.base_ref }}:refs/remotes/origin/${{ github.base_ref }}
           poetry run towncrier check --compare-with origin/${{ github.base_ref }}
-  publish_gh:
-    name: "Publish to GitHub"
-    runs-on: "ubuntu-24.04"
-    # yamllint disable-line rule:quoted-strings
-    if: startsWith(github.ref, 'refs/tags/v')
-    steps:
-      - name: "Check out repository code"
-        uses: "actions/checkout@v4"
-      - name: "Setup environment"
-        uses: "networktocode/gh-action-setup-poetry-environment@v6"
-        with:
-          poetry-version: "1.8.5"
-          python-version: "3.12"
-          poetry-install-options: "--no-root"
-      - name: "Set env"
-        run: "echo RELEASE_VERSION=${GITHUB_REF:10} >> $GITHUB_ENV"
-      - name: "Run Poetry Version"
-        run: "poetry version $RELEASE_VERSION"
-      - name: "Build Documentation"
-        run: "poetry run invoke build-and-check-docs"
-      - name: "Run Poetry Build"
-        run: "poetry build"
-      - name: "Upload binaries to release"
-        run: "gh release upload ${{ github.ref_name }} dist/*.{tar.gz,whl}"
-        env:
-          GH_TOKEN: "${{ secrets.NTC_GITHUB_TOKEN }}"
-    needs:
-      - "pytest"
-  publish_pypi:
-    name: "Push Package to PyPI"
-    runs-on: "ubuntu-24.04"
-    # yamllint disable-line rule:quoted-strings
-    if: startsWith(github.ref, 'refs/tags/v')
-    steps:
-      - name: "Check out repository code"
-        uses: "actions/checkout@v4"
-      - name: "Set up Python"
-        uses: "actions/setup-python@v5"
-        with:
-          python-version: "3.9"
-      - name: "Install Python Packages"
-        run: "pip install poetry"
-      - name: "Set env"
-        run: "echo RELEASE_VERSION=${GITHUB_REF:10} >> $GITHUB_ENV"
-      - name: "Run Poetry Version"
-        run: "poetry version $RELEASE_VERSION"
-      - name: "Run Poetry Build"
-        run: "poetry build"
-      - name: "Push to PyPI"
-        uses: "pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc"  # v1.12.4
-        with:
-          user: "__token__"
-          password: "${{ secrets.PYPI_API_TOKEN }}"
-    needs:
-      - "pytest"
-  slack-notify:
-    needs:
-      - "publish_gh"
-      - "publish_pypi"
-    runs-on: "ubuntu-24.04"
-    env:
-      SLACK_WEBHOOK_URL: "${{ secrets.SLACK_WEBHOOK_URL }}"
-      SLACK_MESSAGE: >-
-        *NOTIFICATION: NEW-RELEASE-PUBLISHED*\n
-        Repository: <${{ github.server_url }}/${{ github.repository }}|${{ github.repository }}>\n
-        Release: <${{ github.server_url }}/${{ github.repository }}/releases/tag/${{ github.ref_name }}|${{ github.ref_name }}>\n
-        Published by: <${{ github.server_url }}/${{ github.actor }}|${{ github.actor }}>
-    steps:
-      - name: "Send a notification to Slack"
-        # ENVs cannot be used directly in job.if. This is a workaround to check
-        # if SLACK_WEBHOOK_URL is present.
-        if: "env.SLACK_WEBHOOK_URL != ''"
-        uses: "slackapi/slack-github-action@fcfb566f8b0aab22203f066d80ca1d7e4b5d05b3"  # v1.27.1
-        with:
-          payload: |
-            {
-              "text": "${{ env.SLACK_MESSAGE }}",
-              "blocks": [
-                {
-                  "type": "section",
-                  "text": {
-                    "type": "mrkdwn",
-                    "text": "${{ env.SLACK_MESSAGE }}"
-                  }
-                }
-              ]
-            }
-        env:
-          SLACK_WEBHOOK_URL: "${{ secrets.SLACK_WEBHOOK_URL }}"
-          SLACK_WEBHOOK_TYPE: "INCOMING_WEBHOOK"