Merge pull request #54 from smk4664/nautobot_banner_support

1.1.0 - Add banner, docs and support for 1.3 jobs.

.github/workflows/ci.yml

@@ -103,8 +103,8 @@ jobs:
  strategy:
  fail-fast: true
  matrix:
- python-version: ["3.6", "3.7", "3.8", "3.9"]
- nautobot-version: ["1.0.1"]
+ python-version: ["3.7", "3.8", "3.9"]
+ nautobot-version: ["1.2.11","1.3.7"]
  runs-on: "ubuntu-20.04"
  env:
  INVOKE_WELCOME_WIZARD_PYTHON_VER: "${{ matrix.python-version }}"
@@ -139,6 +139,10 @@ jobs:
  run: "echo RELEASE_VERSION=${GITHUB_REF:10} >> $GITHUB_ENV"
  - name: "Run Poetry Version"
  run: "poetry version $RELEASE_VERSION"
+ - name: "Install Dependencies (needed for mkdocs)"
+ run: "poetry install"
+ - name: "Build Documentation"
+ run: "poetry run mkdocs build --no-directory-urls --strict"
  - name: "Run Poetry Build"
  run: "poetry build"
  - name: "Upload binaries to release"
@@ -168,6 +172,10 @@ jobs:
  run: "echo RELEASE_VERSION=${GITHUB_REF:10} >> $GITHUB_ENV"
  - name: "Run Poetry Version"
  run: "poetry version $RELEASE_VERSION"
+ - name: "Install Dependencies (needed for mkdocs)"
+ run: "poetry install"
+ - name: "Build Documentation"
+ run: "poetry run mkdocs build --no-directory-urls --strict"
  - name: "Run Poetry Build"
  run: "poetry build"
  - name: "Push to PyPI"

.gitignore

@@ -32,6 +32,7 @@ share/python-wheels/
 .installed.cfg
 *.egg
 MANIFEST
+welcome_wizard/static/welcome_wizard/docs
 
 # PyInstaller
 # Usually these files are written by a python script from a template

README.md

@@ -39,7 +39,7 @@ The plugin is available as a Python package in pypi and can be installed with pi
 pip install nautobot-welcome-wizard
 ```
 
-> The plugin is compatible with Nautobot 1.0.0b4 and higher
+> The plugin is compatible with Nautobot 1.2.0 and higher
 
 To ensure Welcome Wizard is automatically re-installed during future upgrades, create a file named `local_requirements.txt` (if not already existing) in the Nautobot root directory (alongside `requirements.txt`) and list the `nautobot-welcome-wizard` package:
 

mkdocs.yml

@@ -1,6 +1,7 @@
 ---
 dev_addr: "127.0.0.1:8001"
 edit_uri: "edit/main/welcome_wizard/docs"
+site_dir: "welcome_wizard/static/welcome_wizard/docs"
 site_name: "Nautobot Welcome Wizard Documentation"
 site_url: "https://nautobot-plugin-welcome-wizard.readthedocs.io/"
 repo_url: "https://github.com/nautobot/nautobot-plugin-welcome-wizard"