Run latest pylint-nautobot

.github/workflows/pylint_nautobot.yml

@@ -0,0 +1,47 @@
+---
+name: "Latest pylint-nautobot"
+
+on:  # yamllint disable-line rule:truthy rule:comments
+  schedule:
+    - cron: "0 3 */2 * *"  # every other day at 3am
+
+env:
+  APP_NAME: "nautobot-app-dev-example"
+
+jobs:
+  latest-pylint-nautobot:
+    runs-on: "ubuntu-22.04"
+    strategy:
+      fail-fast: true
+      matrix:
+        python-version: ["3.11"]
+        nautobot-version: ["stable"]
+    env:
+      INVOKE_NAUTOBOT_DEV_EXAMPLE_PYTHON_VER: "${{ matrix.python-version }}"
+      INVOKE_NAUTOBOT_DEV_EXAMPLE_NAUTOBOT_VER: "${{ matrix.nautobot-version }}"
+    steps:
+      - name: "Check out repository code"
+        uses: "actions/checkout@v4"
+      - name: "Setup environment"
+        uses: "networktocode/gh-action-setup-poetry-environment@v6"
+      - name: "Set up Docker Buildx"
+        id: "buildx"
+        uses: "docker/setup-buildx-action@v3"
+      - name: "Build"
+        uses: "docker/build-push-action@v5"
+        with:
+          builder: "${{ steps.buildx.outputs.name }}"
+          context: "./"
+          push: false
+          load: true
+          tags: "${{ env.APP_NAME }}/nautobot:${{ matrix.nautobot-version }}-py${{ matrix.python-version }}"
+          file: "./development/Dockerfile"
+          cache-from: "type=gha,scope=${{ matrix.nautobot-version }}-py${{ matrix.python-version }}"
+          cache-to: "type=gha,scope=${{ matrix.nautobot-version }}-py${{ matrix.python-version }}"
+          build-args: |
+            NAUTOBOT_VER=${{ matrix.nautobot-version }}
+            PYTHON_VER=${{ matrix.python-version }}
+      - name: "Copy credentials"
+        run: "cp development/creds.example.env development/creds.env"
+      - name: "Linting: pylint"
+        run: "poetry run invoke pylint --ref=develop"

changes/3.housekeeping

@@ -0,0 +1 @@
+Run latest pylint-nautobot checks workflow.

tasks.py

@@ -680,11 +680,53 @@ def hadolint(context):
     run_command(context, command)
 
 
-@task
-def pylint(context):
+@task(
+    help={
+        "ref": "`pylint-nautobot` git reference to use for the analysis, can be a local path to the repository"
+        ", or a git reference e.g. `--ref=develop`. Use currently installed version if empty. (default: Empty)",
+    }
+)
+def pylint(context, ref=""):
     """Run pylint code analysis."""
-    command = 'pylint --init-hook "import nautobot; nautobot.setup()" --rcfile pyproject.toml nautobot_dev_example'
-    run_command(context, command)
+    pylint_command = [
+        "pylint",
+        '--init-hook="import nautobot; nautobot.setup()"',
+        "--rcfile=pyproject.toml",
+        "nautobot_dev_example",
+    ]
+
+    if not ref:
+        run_command(context, " ".join(pylint_command))
+        return
+
+    pip_and_pylint_command = ["pip install"]
+
+    local_pylint_nautobot_path = Path(ref).resolve().absolute()
+    if local_pylint_nautobot_path.is_dir() and (local_pylint_nautobot_path / "pyproject.toml").is_file():
+        pip_and_pylint_command.append(f"-e {local_pylint_nautobot_path}")
+    else:
+        local_pylint_nautobot_path = None
+        pip_and_pylint_command.append(f"git+https://github.com/nautobot/pylint-nautobot.git@{ref}")
+
+    pip_and_pylint_command += [
+        "&&",
+        *pylint_command,
+    ]
+
+    if is_truthy(context.nautobot_dev_example.local):
+        context.run(" ".join(pip_and_pylint_command))
+        return
+
+    docker_run_command = [
+        "run --rm --entrypoint=''",
+        f"--volume {local_pylint_nautobot_path}:{local_pylint_nautobot_path}" if local_pylint_nautobot_path else "",
+        "-- nautobot sh -c '",
+        *pip_and_pylint_command,
+        "'",
+    ]
+
+    # Do not use `run_command()` to avoid poluting the running container with the installed package
+    docker_compose(context, " ".join(docker_run_command))
 
 
 @task(aliases=("a",))