Release 2.0.0 (#309)

* Update for netmiko 4.x (#308) * Update kwargs in nxos_device.py to fix nautobot-nornir. * Pylint updates. * Update CI for pylint py version. * Fix exceptions * Fix NXOS timeout * Add refresh facts. * Remove save() from nxos install_os as it causes error. * Update pyntc/devices/aireos_device.py Post-review commit (lint) Co-authored-by: Jeff Kala <[email protected]> --------- Co-authored-by: Jeff Kala <[email protected]> * Feature/boot swicth all (#289) Extend cisco_ios boot option lookup. --------- Co-authored-by: tomasgaj <[email protected]> * Release 2.0.0 --------- Co-authored-by: Jeff Kala <[email protected]> Co-authored-by: juanjtomasg <[email protected]> Co-authored-by: tomasgaj <[email protected]>
networktocode · Jan 3, 2024 · 3014dfa · 3014dfa
1 parent 451c3eb
commit 3014dfa
Show file tree

Hide file tree

Showing 20 changed files with 412 additions and 534 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -83,7 +83,7 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]  # "3.10" add back after pyeapi new release.
+        python-version: ["3.8", "3.11"]
     runs-on: "ubuntu-20.04"
     env:
       PYTHON_VER: "${{ matrix.python-version }}"
@@ -114,49 +114,48 @@ jobs:
       - "pydocstyle"
       - "flake8"
       - "yamllint"
-  # TODO: Re-enable after initial pylint issue is completed. https://github.com/networktocode/pyntc/issues/249
-  # pylint:
-  #   runs-on: "ubuntu-20.04"
-  #   strategy:
-  #     fail-fast: true
-  #     matrix:
-  #       python-version: ["3.7"]
-  #   env:
-  #     PYTHON_VER: "${{ matrix.python-version }}"
-  #   steps:
-  #     - name: "Check out repository code"
-  #       uses: "actions/checkout@v2"
-  #     - name: "Setup environment"
-  #       uses: "networktocode/gh-action-setup-poetry-environment@v2"
-  #     - 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@v1"
-  #     - name: "Load the image from cache"
-  #       uses: "docker/build-push-action@v2"
-  #       with:
-  #         builder: "${{ steps.buildx.outputs.name }}"
-  #         context: "./"
-  #         push: false
-  #         load: true
-  #         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 }}
-  #     - name: "Debug: Show docker images"
-  #       run: "docker image ls"
-  #     - name: "Linting: Pylint"
-  #       run: "poetry run invoke pylint"
-  #   needs:
-  #     - "build"
+  pylint:
+    runs-on: "ubuntu-20.04"
+    strategy:
+      fail-fast: true
+      matrix:
+        python-version: ["3.8"]
+    env:
+      PYTHON_VER: "${{ matrix.python-version }}"
+    steps:
+      - name: "Check out repository code"
+        uses: "actions/checkout@v2"
+      - name: "Setup environment"
+        uses: "networktocode/gh-action-setup-poetry-environment@v2"
+      - 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@v1"
+      - name: "Load the image from cache"
+        uses: "docker/build-push-action@v2"
+        with:
+          builder: "${{ steps.buildx.outputs.name }}"
+          context: "./"
+          push: false
+          load: true
+          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 }}
+      - name: "Debug: Show docker images"
+        run: "docker image ls"
+      - name: "Linting: Pylint"
+        run: "poetry run invoke pylint"
+    needs:
+      - "build"
   pytest:
     strategy:
       fail-fast: true
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.8", "3.11"]
     runs-on: "ubuntu-20.04"
     env:
       PYTHON_VER: "${{ matrix.python-version }}"
@@ -188,8 +187,7 @@ jobs:
       - name: "Run Tests"
         run: "poetry run invoke pytest"
     needs:
-      # Remove everything but pylint once pylint is passing.
-      # - "pylint"
+      - "pylint"
       - "bandit"
       - "pydocstyle"
       - "flake8"

diff --git a/docs/admin/release_notes/version_2_0.md b/docs/admin/release_notes/version_2_0.md
@@ -0,0 +1,14 @@
+# v2.0 Release Notes
+
+## [2.0.0] 12-2023
+### Added
+- [308](https://github.com/networktocode/pyntc/pull/308) nxos `refresh()` method to refresh device facts.
+- [289](https://github.com/networktocode/pyntc/pull/289) additional cisco_ios boot options search.
+
+### Changed
+- [308](https://github.com/networktocode/pyntc/pull/308) Updated nxos install_os and logic when waiting for device reload and improved log messages.
+
+### Deprecated
+- [308](https://github.com/networktocode/pyntc/pull/308) Deprecated netmiko argument `delay_factor` in favor of `read_timeout` as per changes in Netmiko 4.0.
+
+  Refer to this blog post for more info about changes in netmiko 4.0: https://pynet.twb-tech.com/blog/netmiko-read-timeout.html
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -113,6 +113,7 @@ nav:
           - v0.19: "admin/release_notes/version_0_19.md"
           - v0.20: "admin/release_notes/version_0_20.md"
           - v1.0: "admin/release_notes/version_1_0.md"
+          - v2.0: "admin/release_notes/version_2_0.md"
   - Developer Guide:
       - Extending the Library: "dev/extending.md"
       - Contributing to the Library: "dev/contributing.md"