diff --git a/nautobot-app/{{ cookiecutter.project_slug }}/.github/workflows/ci.yml b/nautobot-app/{{ cookiecutter.project_slug }}/.github/workflows/ci.yml index c18d11d8..b4babebb 100644 --- a/nautobot-app/{{ cookiecutter.project_slug }}/.github/workflows/ci.yml +++ b/nautobot-app/{{ cookiecutter.project_slug }}/.github/workflows/ci.yml @@ -13,7 +13,7 @@ on: # yamllint disable-line rule:truthy rule:comments pull_request: ~ env: - PLUGIN_NAME: "{{cookiecutter.project_slug}}" + PLUGIN_NAME: "{{cookiecutter.plugin_slug}}" jobs: black: @@ -138,7 +138,7 @@ jobs: fail-fast: true matrix: python-version: ["3.11"] - nautobot-version: ["{{cookiecutter.min_nautobot_version}}"] + nautobot-version: ["1.6.0"] env: INVOKE_{{cookiecutter.plugin_name.upper()}}_PYTHON_VER: "{% raw %}${{ matrix.python-version }}{% endraw %}" INVOKE_{{cookiecutter.plugin_name.upper()}}_NAUTOBOT_VER: "{% raw %}${{ matrix.nautobot-version }}{% endraw %}" @@ -177,14 +177,14 @@ jobs: matrix: python-version: ["3.8", "3.11"] db-backend: ["postgresql"] - nautobot-version: ["stable"] + nautobot-version: ["1.6"] include: - python-version: "3.11" db-backend: "postgresql" nautobot-version: "{{cookiecutter.min_nautobot_version}}" - python-version: "3.11" db-backend: "mysql" - nautobot-version: "stable" + nautobot-version: "1.6" runs-on: "ubuntu-22.04" env: INVOKE_{{cookiecutter.plugin_name.upper()}}_PYTHON_VER: "{% raw %}${{ matrix.python-version }}{% endraw %}" diff --git a/nautobot-app/{{ cookiecutter.project_slug }}/development/docker-compose.base.yml b/nautobot-app/{{ cookiecutter.project_slug }}/development/docker-compose.base.yml index 8ab8e986..10ef5e99 100644 --- a/nautobot-app/{{ cookiecutter.project_slug }}/development/docker-compose.base.yml +++ b/nautobot-app/{{ cookiecutter.project_slug }}/development/docker-compose.base.yml @@ -13,7 +13,6 @@ x-nautobot-base: &nautobot-base - "creds.env" tty: true -version: "3.8" services: nautobot: depends_on: diff --git a/nautobot-app/{{ cookiecutter.project_slug }}/development/docker-compose.dev.yml b/nautobot-app/{{ cookiecutter.project_slug }}/development/docker-compose.dev.yml index 7defeae5..f8ca77ea 100644 --- a/nautobot-app/{{ cookiecutter.project_slug }}/development/docker-compose.dev.yml +++ b/nautobot-app/{{ cookiecutter.project_slug }}/development/docker-compose.dev.yml @@ -3,7 +3,6 @@ # any override will need to include these volumes to use them. # see: https://github.com/docker/compose/issues/3729 --- -version: "3.8" services: nautobot: command: "nautobot-server runserver 0.0.0.0:8080" diff --git a/nautobot-app/{{ cookiecutter.project_slug }}/development/docker-compose.mysql.yml b/nautobot-app/{{ cookiecutter.project_slug }}/development/docker-compose.mysql.yml index 062ada94..dbe31cba 100644 --- a/nautobot-app/{{ cookiecutter.project_slug }}/development/docker-compose.mysql.yml +++ b/nautobot-app/{{ cookiecutter.project_slug }}/development/docker-compose.mysql.yml @@ -1,6 +1,4 @@ --- -version: "3.8" - services: nautobot: environment: @@ -19,7 +17,6 @@ services: db: image: "mysql:8" command: - - "--default-authentication-plugin=mysql_native_password" - "--max_connections=1000" env_file: - "development.env" diff --git a/nautobot-app/{{ cookiecutter.project_slug }}/development/docker-compose.postgres.yml b/nautobot-app/{{ cookiecutter.project_slug }}/development/docker-compose.postgres.yml index 12d1de31..8d96fdba 100644 --- a/nautobot-app/{{ cookiecutter.project_slug }}/development/docker-compose.postgres.yml +++ b/nautobot-app/{{ cookiecutter.project_slug }}/development/docker-compose.postgres.yml @@ -1,6 +1,4 @@ --- -version: "3.8" - services: nautobot: environment: diff --git a/nautobot-app/{{ cookiecutter.project_slug }}/development/docker-compose.redis.yml b/nautobot-app/{{ cookiecutter.project_slug }}/development/docker-compose.redis.yml index 6da9fa01..b5e266a3 100644 --- a/nautobot-app/{{ cookiecutter.project_slug }}/development/docker-compose.redis.yml +++ b/nautobot-app/{{ cookiecutter.project_slug }}/development/docker-compose.redis.yml @@ -1,5 +1,4 @@ --- -version: "3.8" services: redis: image: "redis:6-alpine" diff --git a/nautobot-app/{{ cookiecutter.project_slug }}/docs/dev/dev_environment.md b/nautobot-app/{{ cookiecutter.project_slug }}/docs/dev/dev_environment.md index 04bdc234..cbaeb2c5 100644 --- a/nautobot-app/{{ cookiecutter.project_slug }}/docs/dev/dev_environment.md +++ b/nautobot-app/{{ cookiecutter.project_slug }}/docs/dev/dev_environment.md @@ -31,7 +31,7 @@ This project is managed by [Python Poetry](https://python-poetry.org/) and has a 1. Install Poetry, see the [Poetry documentation](https://python-poetry.org/docs/#installation) for your operating system. 2. Install Docker, see the [Docker documentation](https://docs.docker.com/get-docker/) for your operating system. -3. Install Docker-compose, see the [Docker-compose documentation](https://github.com/docker/compose) for your operation system. +3. Install Docker Compose v2, see the [Docker Compose documentation](https://github.com/docker/compose) for your operation system. Once you have Poetry and Docker installed you can run the following commands (in the root of the repository) to install all other development dependencies in an isolated Python virtual environment: @@ -190,7 +190,7 @@ Next, you need to start up your Docker containers. ```bash ➜ invoke start Starting Nautobot in detached mode... -Running docker-compose command "up --detach" +Running docker compose command "up --detach" Creating network "{{ cookiecutter.plugin_name }}_default" with the default driver Creating volume "{{ cookiecutter.plugin_name }}_postgres_data" with default driver Creating {{ cookiecutter.plugin_name }}_redis_1 ... @@ -241,8 +241,8 @@ If you need to create additional superusers, run the follow commands. ```bash ➜ invoke createsuperuser -Running docker-compose command "ps --services --filter status=running" -Running docker-compose command "exec nautobot nautobot-server createsuperuser --username admin" +Running docker compose command "ps --services --filter status=running" +Running docker compose command "exec nautobot nautobot-server createsuperuser --username admin" Error: That username is already taken. Username: ntc Email address: ntc@networktocode.com @@ -258,7 +258,7 @@ The last command to know for now is `invoke stop`. ```bash ➜ invoke stop Stopping Nautobot... -Running docker-compose command "down" +Running docker compose command "down" Stopping {{ cookiecutter.plugin_name }}_worker_1 ... Stopping {{ cookiecutter.plugin_name }}_nautobot_1 ... Stopping {{ cookiecutter.plugin_name }}_docs_1 ... diff --git a/nautobot-app/{{ cookiecutter.project_slug }}/docs/requirements.txt b/nautobot-app/{{ cookiecutter.project_slug }}/docs/requirements.txt index d168c88f..bf10c13b 100644 --- a/nautobot-app/{{ cookiecutter.project_slug }}/docs/requirements.txt +++ b/nautobot-app/{{ cookiecutter.project_slug }}/docs/requirements.txt @@ -1,5 +1,6 @@ -mkdocs==1.5.2 -mkdocs-material==9.1.15 -mkdocs-version-annotations==1.0.0 -mkdocstrings-python==1.5.2 -mkdocstrings==0.22.0 +mkdocs==1.6.0 +mkdocs-material==9.5.32 +markdown-version-annotations==1.0.1 +griffe==1.1.1 +mkdocstrings-python==1.10.8 +mkdocstrings==0.25.2 diff --git a/nautobot-app/{{ cookiecutter.project_slug }}/mkdocs.yml b/nautobot-app/{{ cookiecutter.project_slug }}/mkdocs.yml index 9696cc77..2af12c95 100644 --- a/nautobot-app/{{ cookiecutter.project_slug }}/mkdocs.yml +++ b/nautobot-app/{{ cookiecutter.project_slug }}/mkdocs.yml @@ -1,6 +1,6 @@ --- dev_addr: "127.0.0.1:8001" -edit_uri: "edit/main/{{cookiecutter.project_slug}}/docs" +edit_uri: "edit/main/docs" site_dir: "{{cookiecutter.plugin_name}}/static/{{cookiecutter.plugin_name}}/docs" site_name: "{{cookiecutter.verbose_name}} Documentation" site_url: "{{cookiecutter.docs_app_url}}/" @@ -72,6 +72,8 @@ extra: link: "https://twitter.com/networktocode" name: "Network to Code Twitter" markdown_extensions: + - "markdown_version_annotations": + admonition_tag: "???" - "admonition" - "toc": permalink: true @@ -85,7 +87,6 @@ markdown_extensions: - "footnotes" plugins: - "search" - - "mkdocs-version-annotations" - "mkdocstrings": default_handler: "python" handlers: diff --git a/nautobot-app/{{ cookiecutter.project_slug }}/pyproject.toml b/nautobot-app/{{ cookiecutter.project_slug }}/pyproject.toml index f542d4db..c91bd292 100644 --- a/nautobot-app/{{ cookiecutter.project_slug }}/pyproject.toml +++ b/nautobot-app/{{ cookiecutter.project_slug }}/pyproject.toml @@ -45,19 +45,20 @@ ipython = "*" pydocstyle = "*" pylint = "*" pylint-django = "*" -pylint-nautobot = "*" +pylint-nautobot = "^0.3.1" yamllint = "*" toml = "*" Markdown = "*" # Rendering docs to HTML -mkdocs = "1.5.2" +mkdocs = "1.6.0" # Material for MkDocs theme -mkdocs-material = "9.1.15" +mkdocs-material = "9.5.32" # Render custom markdown for version added/changed/remove notes -mkdocs-version-annotations = "1.0.0" +rkdown-version-annotations = "1.0.1" # Automatic documentation from sources, for MkDocs -mkdocstrings = "0.22.0" -mkdocstrings-python = "1.5.2" +mkdocstrings = "0.25.2" +mkdocstrings-python = "1.10.8" +griffe = "1.1.1" [tool.poetry.extras] all = [