Initial pass at updating to 2025 best practices (#336)

* Initial pass at updated to 2025 best practices

* fix ci missing build stage

* fix ci invoke lock issue

* fix ci remove markdownlint

* fix ci comment out doc builds for time being

* update Dockerfile to use poetry install script

* fix ruff target-version

* Apply suggestions from code review

Co-authored-by: Joe Wesch <[email protected]>

* fix print debug

* Update tasks.py

Co-authored-by: Joe Wesch <[email protected]>

* remove unused import of os

* fix ruff target-version

* fix formatting

* fixing tagging

* fixing env vars in ci

* fixing env vars in ci

* fix dockerfile properly this time

* fix dockerfile properly this time

* make poetry install match nautobot best practices

---------

Co-authored-by: Joe Wesch <[email protected]>

Author: jeffkala

.bandit.yml

@@ -4,8 +4,8 @@ about: Report a reproducible bug in the current release of pyntc
 ---
 
 ### Environment
-* Python version:  <!-- Example: 3.7.7 -->
-* pyntc version:  <!-- Example: 1.0.0 -->
+* Python version:  <!-- Example: 3.11.2 -->
+* pyntc version:  <!-- Example: 2.0.2 -->
 
 <!-- What did you expect to happen? -->
 ### Expected Behavior

.flake8

@@ -5,7 +5,7 @@ about: Propose a new feature or enhancement
 ---
 
 ### Environment
-* pyntc version:  <!-- Example: 1.0.0 -->
+* pyntc version:  <!-- Example: 2.0.2 -->
 
 <!--
     Describe in detail the new functionality you are proposing.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -13,107 +13,76 @@ on:  # yamllint disable-line rule:truthy rule:comments
   pull_request: ~
 
 env:
-  IMAGE_NAME: "pyntc"
+  INVOKE_PYNTC_IMAGE_NAME: "pyntc"
+  INVOKE_PYNTC_IMAGE_VER: "latest"
 
 jobs:
-  black:
+  ruff-format:
     runs-on: "ubuntu-24.04"
     env:
-      INVOKE_LOCAL: "True"
+      INVOKE_PYNTC_LOCAL: "True"
     steps:
       - name: "Check out repository code"
         uses: "actions/checkout@v4"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
-      - name: "Linting: black"
-        run: "poetry run invoke black"
-  bandit:
-    runs-on: "ubuntu-24.04"
-    env:
-      INVOKE_LOCAL: "True"
-    steps:
-      - name: "Check out repository code"
-        uses: "actions/checkout@v4"
-      - name: "Setup environment"
-        uses: "networktocode/gh-action-setup-poetry-environment@v6"
-      - name: "Linting: bandit"
-        run: "poetry run invoke bandit"
-    needs:
-      - "black"
-  pydocstyle:
+        with:
+          poetry-version: "1.8.5"
+      - name: "Linting: ruff format"
+        run: "poetry run invoke ruff --action format"
+  ruff-lint:
     runs-on: "ubuntu-24.04"
     env:
-      INVOKE_LOCAL: "True"
+      INVOKE_PYNTC_LOCAL: "True"
     steps:
       - name: "Check out repository code"
         uses: "actions/checkout@v4"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
-      - name: "Linting: pydocstyle"
-        run: "poetry run invoke pydocstyle"
-    needs:
-      - "black"
-  flake8:
+        with:
+          poetry-version: "1.8.5"
+      - name: "Linting: ruff"
+        run: "poetry run invoke ruff --action lint"
+  # Temporarily disabled due to issues with the docs build and needing best practices for NTC python builds.
+  # check-docs-build:
+  #   runs-on: "ubuntu-24.04"
+  #   env:
+  #     INVOKE_PYNTC_LOCAL: "True"
+  #   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"
+  #     - name: "Check Docs Build"
+  #       run: "poetry run invoke build-and-check-docs"
+  poetry:
     runs-on: "ubuntu-24.04"
     env:
-      INVOKE_LOCAL: "True"
+      INVOKE_PYNTC_LOCAL: "True"
     steps:
       - name: "Check out repository code"
         uses: "actions/checkout@v4"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
-      - name: "Linting: flake8"
-        run: "poetry run invoke flake8"
-    needs:
-      - "black"
+        with:
+          poetry-version: "1.8.5"
+      - name: "Checking: poetry lock file"
+        run: "poetry lock --check"
   yamllint:
     runs-on: "ubuntu-24.04"
     env:
-      INVOKE_LOCAL: "True"
+      INVOKE_PYNTC_LOCAL: "True"
     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"
       - name: "Linting: yamllint"
         run: "poetry run invoke yamllint"
-    needs:
-      - "black"
-  build:
-    strategy:
-      fail-fast: true
-      matrix:
-        python-version: ["3.9", "3.10", "3.11", "3.12"]
-    runs-on: "ubuntu-24.04"
-    env:
-      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"
-      - name: "Get image version"
-        run: "echo IMAGE_VER=`poetry version -s`-py${{ matrix.python-version }} >> $GITHUB_ENV"
-      - name: "Set up Docker Buildx"
-        id: "buildx"
-        uses: "docker/setup-buildx-action@v3"
-      - name: "Build"
-        uses: "docker/build-push-action@v6"
-        with:
-          builder: "${{ steps.buildx.outputs.name }}"
-          context: "./"
-          push: false
-          tags: "${{ env.IMAGE_NAME }}:${{ env.IMAGE_VER }}"
-          file: "./Dockerfile"
-          cache-from: "type=gha,scope=${{ env.IMAGE_NAME }}-${{ env.IMAGE_VER }}-py${{ matrix.python-version }}"
-          cache-to: "type=gha,scope=${{ env.IMAGE_NAME }}-${{ env.IMAGE_VER }}-py${{ matrix.python-version }}"
-          build-args: |
-            PYTHON_VER=${{ env.PYTHON_VER }}
-    needs:
-      - "bandit"
-      - "pydocstyle"
-      - "flake8"
-      - "yamllint"
   pylint:
     runs-on: "ubuntu-24.04"
     strategy:
@@ -128,29 +97,27 @@ jobs:
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
       - name: "Get image version"
-        run: "echo IMAGE_VER=`poetry version -s`-py${{ matrix.python-version }} >> $GITHUB_ENV"
+        run: "echo INVOKE_PYNTC_IMAGE_VER=`poetry version -s`-py${{ matrix.python-version }} >> $GITHUB_ENV"
       - name: "Set up Docker Buildx"
         id: "buildx"
-        uses: "docker/setup-buildx-action@v3"
-      - name: "Load the image from cache"
-        uses: "docker/build-push-action@v6"
+        uses: "docker/setup-buildx-action@b5ca514318bd6ebac0fb2aedd5d36ec1b5c232a2"  # v3.10.0
+      - name: "Build"
+        uses: "docker/build-push-action@ca052bb54ab0790a636c9b5f226502c73d547a25"  # v5.4.0
         with:
           builder: "${{ steps.buildx.outputs.name }}"
           context: "./"
           push: false
           load: true
-          tags: "${{ env.IMAGE_NAME }}:${{ env.IMAGE_VER }}"
+          tags: "${{ env.INVOKE_PYNTC_IMAGE_NAME }}:${{ env.INVOKE_PYNTC_IMAGE_VER }}"
           file: "./Dockerfile"
-          cache-from: "type=gha,scope=${{ env.IMAGE_NAME }}-${{ env.IMAGE_VER }}-py${{ matrix.python-version }}"
-          cache-to: "type=gha,scope=${{ env.IMAGE_NAME }}-${{ env.IMAGE_VER }}-py${{ matrix.python-version }}"
+          cache-from: "type=gha,scope=${{ env.INVOKE_PYNTC_IMAGE_NAME }}-${{ env.INVOKE_PYNTC_IMAGE_VER }}-py${{ matrix.python-version }}"
+          cache-to: "type=gha,scope=${{ env.INVOKE_PYNTC_IMAGE_NAME }}-${{ env.INVOKE_PYNTC_IMAGE_VER }}-py${{ matrix.python-version }}"
           build-args: |
             PYTHON_VER=${{ env.PYTHON_VER }}
       - name: "Debug: Show docker images"
         run: "docker image ls"
       - name: "Linting: Pylint"
         run: "poetry run invoke pylint"
-    needs:
-      - "build"
   pytest:
     strategy:
       fail-fast: true
@@ -165,33 +132,27 @@ jobs:
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
       - name: "Get image version"
-        run: "echo IMAGE_VER=`poetry version -s`-py${{ matrix.python-version }} >> $GITHUB_ENV"
+        run: "echo INVOKE_PYNTC_IMAGE_VER=`poetry version -s`-py${{ matrix.python-version }} >> $GITHUB_ENV"
       - name: "Set up Docker Buildx"
         id: "buildx"
-        uses: "docker/setup-buildx-action@v3"
-      - name: "Load the image from cache"
-        uses: "docker/build-push-action@v6"
+        uses: "docker/setup-buildx-action@b5ca514318bd6ebac0fb2aedd5d36ec1b5c232a2"  # v3.10.0
+      - name: "Build"
+        uses: "docker/build-push-action@ca052bb54ab0790a636c9b5f226502c73d547a25"  # v5.4.0
         with:
           builder: "${{ steps.buildx.outputs.name }}"
           context: "./"
           push: false
           load: true
-          tags: "${{ env.IMAGE_NAME }}:${{ env.IMAGE_VER }}"
+          tags: "${{ env.INVOKE_PYNTC_IMAGE_NAME }}:${{ env.INVOKE_PYNTC_IMAGE_VER }}"
           file: "./Dockerfile"
-          cache-from: "type=gha,scope=${{ env.IMAGE_NAME }}-${{ env.IMAGE_VER }}-py${{ matrix.python-version }}"
-          cache-to: "type=gha,scope=${{ env.IMAGE_NAME }}-${{ env.IMAGE_VER }}-py${{ matrix.python-version }}"
+          cache-from: "type=gha,scope=${{ env.INVOKE_PYNTC_IMAGE_NAME }}-${{ env.INVOKE_PYNTC_IMAGE_VER }}-py${{ matrix.python-version }}"
+          cache-to: "type=gha,scope=${{ env.INVOKE_PYNTC_IMAGE_NAME }}-${{ env.INVOKE_PYNTC_IMAGE_VER }}-py${{ matrix.python-version }}"
           build-args: |
             PYTHON_VER=${{ env.PYTHON_VER }}
       - name: "Debug: Show docker images"
         run: "docker image ls"
       - name: "Run Tests"
         run: "poetry run invoke pytest"
-    needs:
-      - "pylint"
-      - "bandit"
-      - "pydocstyle"
-      - "flake8"
-      - "yamllint"
   publish_gh:
     name: "Publish to GitHub"
     runs-on: "ubuntu-24.04"
@@ -210,16 +171,14 @@ jobs:
         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"
-        uses: "svenstaro/upload-release-action@v2"
-        with:
-          repo_token: "${{ secrets.NTC_GITHUB_TOKEN }}"
-          file: "dist/*"
-          tag: "${{ github.ref }}"
-          overwrite: true
-          file_glob: true
+        run: "gh release upload ${{ github.ref_name }} dist/*.{tar.gz,whl}"
+        env:
+          GH_TOKEN: "${{ secrets.NTC_GITHUB_TOKEN }}"
     needs:
       - "pytest"
   publish_pypi:
@@ -243,9 +202,44 @@ jobs:
       - name: "Run Poetry Build"
         run: "poetry build"
       - name: "Push to PyPI"
-        uses: "pypa/gh-action-pypi-publish@release/v1"
+        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"

.github/ISSUE_TEMPLATE/feature_request.md

@@ -14,7 +14,7 @@ build:
 
 mkdocs:
   configuration: "mkdocs.yml"
-  # fail_on_warning: true
+  fail_on_warning: true
 
 # Use our docs/requirements.txt during installation.
 python:

.github/styles/dummy.txt

@@ -1,8 +1,9 @@
 ---
 extends: "default"
 rules:
-  comments: "enable"
-  empty-values: "disable"
+  comments:
+    min-spaces-from-content: 1
+  empty-values: "enable"
   indentation:
     indent-sequences: "consistent"
   line-length: "disable"