Merge pull request #186 from nautobot/develop

Release v1.11.0

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,31 @@
+<!--
+    Thank you for your interest in contributing to Nautobot ChatOps! Please note
+    that our contribution policy recommends that a feature request or bug
+    report be opened for approval prior to filing a pull request. This
+    helps avoid wasting time and effort on something that we might not
+    be able to accept.
+
+    Please indicate the relevant feature request or bug report below.
+-->
+# Closes: #<ISSUE NUMBER GOES HERE>
+
+## What's Changed
+<!--
+    Please include:
+    - A summary of the proposed changes
+    - A sectioned breakdown for larger features under ## subheadings
+    - Screenshots, example payloads where relevant:
+      - Before/After for bugfixes
+      - Using a new feature
+-->
+
+## TODO
+<!--
+    Please feel free to update todos to keep track of your own notes for WIP PRs.
+-->
+- [ ] Explanation of Change(s)
+- [ ] Added change log fragment(s) (for more information see [the documentation](https://docs.nautobot.com/projects/chatops/en/latest/dev/dev_contributing/#creating-changelog-fragments))
+- [ ] Attached Screenshots, Payload Example
+- [ ] Unit, Integration Tests
+- [ ] Documentation Updates (when adding/changing features)
+- [ ] Outline Remaining Work, Constraints from Design

.github/workflows/ci.yml

@@ -103,12 +103,8 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        python-version: ["3.7", "3.8", "3.9"]
-        nautobot-version: ["1.3.0", "1.4.2"]
-        # Also test Python 3.10 with Nautobot 1.3.x
-        include:
-          - python-version: "3.10"
-            nautobot-version: "1.4.2"
+        python-version: ["3.7", "3.8", "3.9", "3.10"]
+        nautobot-version: ["1.4.2", "latest"]
     runs-on: "ubuntu-20.04"
     env:
       INVOKE_NAUTOBOT_CHATOPS_PYTHON_VER: "${{ matrix.python-version }}"
@@ -122,11 +118,6 @@ jobs:
           python-version: "${{ matrix.python-version }}"
       - name: "Copy credentials"
         run: "cp development/creds.example.env development/creds.env"
-      - name: "Remove Poetry Lock for Older Nautobot Tests"
-        run: "rm -f poetry.lock"
-        if: "matrix.nautobot-version != '1.4.2'"
-      - name: "Set Nautobot install to the testing version"
-        run: "poetry add nautobot==${{ matrix.nautobot-version }}"
       - name: "Build Container"
         run: "poetry run invoke build"
       - name: "Run Tests"
@@ -196,3 +187,18 @@ jobs:
           password: "${{ secrets.PYPI_API_TOKEN }}"
     needs:
       - "unittest"
+
+  changelog:
+    if: github.base_ref == 'develop' || github.base_ref == 'next'
+    runs-on: "ubuntu-20.04"
+    steps:
+      - name: "Check out repository code"
+        uses: "actions/checkout@v2"
+        with:
+          fetch-depth: "0"
+      - name: "Setup environment"
+        uses: "networktocode/gh-action-setup-poetry-environment@v2"
+      - 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 }}

.github/workflows/upstream_testing.yml

@@ -0,0 +1,13 @@
+---
+name: "Nautobot Upstream Testing"
+
+on:  # yamllint disable-line rule:truthy rule:comments
+  schedule:
+    - cron: "0 4 */2 * *"  # every other day at midnight
+
+jobs:
+  upstream-test:
+    uses: "nautobot/nautobot/.github/workflows/plugin_upstream_testing_base.yml@develop"
+    with:  # Below could potentially be collapsed into a single argument if a concrete relationship between both is enforced
+      invoke_context_name: "NAUTOBOT_CHATOPS"
+      plugin_name: "nautobot-chatops-plugin"

.gitignore

@@ -193,28 +193,8 @@ $RECYCLE.BIN/
 # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
 # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
 
-# User-specific stuff
-.idea/**/workspace.xml
-.idea/**/tasks.xml
-.idea/**/usage.statistics.xml
-.idea/**/dictionaries
-.idea/**/shelf
-
-# Generated files
-.idea/**/contentModel.xml
-
-# Sensitive or high-churn files
-.idea/**/dataSources/
-.idea/**/dataSources.ids
-.idea/**/dataSources.local.xml
-.idea/**/sqlDataSources.xml
-.idea/**/dynamic.xml
-.idea/**/uiDesigner.xml
-.idea/**/dbnavigator.xml
-
-# Gradle
-.idea/**/gradle.xml
-.idea/**/libraries
+# Jetbrains IDE configs
+.idea/
 
 # Gradle and Maven with auto-import
 # When using Gradle or Maven with auto-import, you should exclude module files,

CHANGELOG.md

@@ -1,109 +1,4 @@
 <!-- markdownlint-disable MD024 -->
 # Changelog - Nautobot Plugin ChatOps
 
-## 1.8.0
-
-### Additions
-
-Adds support For Nautobot 1.3
-
-### Removes
-
-Nautobot 1.0.x support
-Python 3.6 support
-
-## v1.7.0
-
-### Additions
-
-(#123) Adds export button of command usage
-(#128) Adds QOL change for focusing of fields
-
-### Fixes
-
-(#129) Fixes errors on private messages
-(#128) Access grants updates
-
-## v1.6.0
-
-### Additions
-
-(#123) Added export button for chat command usage as CSV
-(#120) Added `send_all_messages_private` setting
-
-## v1.5.1
-
-(#97) Fixes MS Teams Bold markdown. Moves from **<text>** to *<text>* to align with guides from Microsoft
-
-## v1.5.0
-
-### Updates
-
-- Introduced support for MySQL database backends
-- Introduced support for Nautobot Celery workers
-
-### Fixes
-
-#17 - Error with filtering by empty regions, no message back
-
-## v1.4.1
-
-### Updates
-
-Minor update to better handle the versioning. This fixes an issue where the version number within Nautobot was not updated alongside the pyproject.toml.
-
-## v1.4.0
-
-Updates Nautobot ChatOps name for Webex Teams to Webex. As part of Cisco's renaming of Webex Teams to just Webex, the underlying configuration was updated.
-
-### Fixes
-
-(#68) Correct var names for Nautobot
-(#61) Mattermost sending interactive Dialog
-
-### Updates
-
-(#63) Add additional Breadcrumbs
-(#24) Rename Webex Teams to Webex
-
-## v1.3.1
-
-### Fixes
-(#54) Reverted pinning of cryptography
-
-## v1.3.0
-
-Updates to pyjwt to address concerns with other dependencies in the Nautobot ecosystem.
-
-### Updates
-
-Updates pyjwt from 1.7.1 minimum to 2.1
-Adds cryptography as separate requirement
-
-## v1.2.0
-
-- Replaces Slack client (slack_client) with Slack SDK (https://pypi.org/project/slack-sdk/)
-- This update does not require any code changes to the bots that leverage Slack. This does require the update of system requirements on installation.
-
-### Fixes
-#2 - Cisco WebEx error on content too large
-
-## v1.1.0
-
-### What's New
-
-Slack handling of list items > 100 items, now including a next option in the drop down list to get more options #10
-
-### Bug Fixes
-Updated MS Teams Zip File #29
-Fix connection filter ordering #23
-
-## v1.0.1
-
-### FIXES
-
-Fix issue with new Status field
-
-## v1.0.0
-
-Initial Release
+The changelog has been moved to the [project release notes](https://docs.nautobot.com/projects/chatops/en/latest/admin/release_notes/).