chore(merge): 'main' into 'work/CRAFT-3154/craft-platforms'

.github/renovate.json5

@@ -1,20 +1,22 @@
 {
   // Configuration file for RenovateBot: https://docs.renovatebot.com/configuration-options
-  extends: ["config:base"],
+  extends: ["config:recommended", ":semanticCommitTypeAll(build)"],
   labels: ["dependencies"],  // For convenient searching in GitHub
+  baseBranches: ["$default", "/^hotfix\\/.*/"],
   pip_requirements: {
     fileMatch: ["^tox.ini$", "(^|/)requirements([\\w-]*)\\.txt$", "^.pre-commit-config.yaml$"]
   },
    packageRules: [
     {
       // Internal package minor patch updates get top priority, with auto-merging
-      groupName: "internal package patch releases",
+      groupName: "internal package minor releases",
       matchPackagePatterns: ["^craft-.*"],
       matchUpdateTypes: ["minor", "patch", "pin", "digest"],
       prPriority: 10,
       automerge: true,
       minimumReleaseAge: "0 seconds",
       schedule: ["at any time"],
+      matchBaseBranches: ["$default"],  // Only do minor releases on main
     },
     {
       // Same as above, but for hotfix branches, only for patch, and without auto-merging.
@@ -24,23 +26,24 @@
       prPriority: 10,
       minimumReleaseAge: "0 seconds",
       schedule: ["at any time"],
-      matchBaseBranches: ["/^hotfix/.*/"],  // All hotfix branches
+      matchBaseBranches: ["/^hotfix\\/.*/"],  // All hotfix branches
     },
     {
       // Automerge patches, pin changes and digest changes.
       // Also groups these changes together.
       groupName: "bugfixes",
-      excludePackagePrefixes: ["lint", "types"],
+      excludeDepPatterns: ["lint/.*", "types/.*"],
       matchUpdateTypes: ["patch", "pin", "digest"],
       prPriority: 3, // Patches should go first!
       automerge: true
     },
     {
       // Update all internal packages in one higher-priority PR
       groupName: "internal packages",
-      matchPackagePrefixes: ["craft-", "snap-"],
-      matchLanguages: ["python"],
-      prPriority: 2
+      matchDepPatterns: ["craft-.*", "snap-.*"],
+      matchCategories: ["python"],
+      prPriority: 2,
+      matchBaseBranches: ["$default"],  // Not for hotfix branches
     },
     {
       // GitHub Actions are higher priority to update than most dependencies since they don't tend to break things.
@@ -59,10 +62,32 @@
       // Minor changes can be grouped and automerged for dev dependencies, but are also deprioritised.
       groupName: "development dependencies (non-major)",
       groupSlug: "dev-dependencies",
-      matchPackagePrefixes: [
-        "dev",
-        "lint",
-        "types"
+      matchDepPatterns: [
+        "dev/.*",
+        "lint/.*",
+        "types/.*"
+      ],
+      matchPackagePatterns: [
+        // Brought from charmcraft. May not be complete.
+        // This helps group dependencies in requirements-dev.txt files.
+        "^(.*/)?autoflake$",
+        "^(.*/)?black$",
+        "^(.*/)?codespell$",
+        "^(.*/)?coverage$",
+        "^(.*/)?flake8$",
+        "^(.*/)?hypothesis$",
+        "^(.*/)?mypy$",
+        "^(.*/)?pycodestyle$",
+        "^(.*/)?docstyle$",
+        "^(.*/)?pyfakefs$",
+        "^(.*/)?pyflakes$",
+        "^(.*/)?pylint$",
+        "^(.*/)?pytest",
+        "^(.*/)?responses$",
+        "^(.*/)?ruff$",
+        "^(.*/)?twine$",
+        "^(.*/)?tox$",
+        "^(.*/)?types-",
       ],
       matchUpdateTypes: ["minor", "patch", "pin", "digest"],
       prPriority: -1,
@@ -74,32 +99,37 @@
       groupSlug: "doc-dependencies",
       matchPackageNames: ["Sphinx", "furo"],
       matchPackagePatterns: ["[Ss]phinx.*$"],
-      matchPackagePrefixes: ["docs"],
+      matchDepPatterns: ["docs/.*"],
+      matchBaseBranches: ["$default"],  // Not for hotfix branches
     },
     {
       // Other major dependencies get deprioritised below minor dev dependencies.
       matchUpdateTypes: ["major"],
-      prPriority: -2
+      prPriority: -2,
+      matchBaseBranches: ["$default"],  // Not for hotfix branches
     },
     {
       // Major dev dependencies are stone last, but grouped.
       groupName: "development dependencies (major versions)",
       groupSlug: "dev-dependencies",
       matchDepTypes: ["devDependencies"],
       matchUpdateTypes: ["major"],
-      prPriority: -3
+      prPriority: -3,
+      matchBaseBranches: ["$default"],  // Not for hotfix branches
     },
     {
       // Pyright makes regular breaking changes in patch releases, so we separate these
       // and do them independently.
       matchPackageNames: ["pyright", "types/pyright"],
-      prPriority: -4
+      prPriority: -4,
+      matchBaseBranches: ["$default"],  // Not for hotfix branches
     }
   ],
-  regexManagers: [
+  customManagers: [
     {
       // tox.ini can get updates too if we specify for each package.
       fileMatch: ["tox.ini"],
+      customType: "regex",
       depTypeTemplate: "devDependencies",
       matchStrings: [
         "# renovate: datasource=(?<datasource>\\S+)\n\\s+(?<depName>.*?)(\\[[\\w]*\\])*[=><]=?(?<currentValue>.*?)\n"
@@ -108,6 +138,7 @@
     {
       // .pre-commit-config.yaml version updates
       fileMatch: [".pre-commit-config.yaml"],
+      customType: "regex",
       datasourceTemplate: "pypi",
       depTypeTemplate: "lint",
       matchStrings: [
@@ -122,7 +153,7 @@
   prCreation: "not-pending", // Wait until status checks have completed before raising the PR
   prNotPendingHours: 4, // ...unless the status checks have been running for 4+ hours.
   prHourlyLimit: 1, // No more than 1 PR per hour.
-  stabilityDays: 2, // Wait 2 days from release before updating.
+  minimumReleaseAge: "2 days",
   automergeStrategy: "squash", // Squash & rebase when auto-merging.
   semanticCommitType: "build"  // use `build` as commit header type (i.e. `build(deps): <description>`)
 }

.github/workflows/check-renovate.yaml

@@ -0,0 +1,40 @@
+name: Renovate check
+on:
+  pull_request:
+    paths:
+      - ".github/workflows/check-renovate.yaml"
+      - ".github/renovate.json5"
+
+  # Allows triggering the workflow manually from the Actions tab
+  workflow_dispatch:
+    inputs:
+      enable_ssh_access:
+        type: boolean
+        description: 'Enable ssh access'
+        required: false
+        default: false
+
+jobs:
+  renovate:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Install node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+      - name: Install renovate
+        run: npm install --global renovate
+      - name: Enable ssh access
+        uses: mxschmitt/action-tmate@v3
+        if: ${{ inputs.enable_ssh_access }}
+        with:
+          limit-access-to-actor: true
+      - name: Check renovate config
+        run: renovate-config-validator .github/renovate.json5
+      - name: Renovate dry-run
+        run: renovate --dry-run --autodiscover
+        env:
+          RENOVATE_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          RENOVATE_USE_BASE_BRANCH_CONFIG: ${{ github.ref }}

.github/workflows/tests.yaml

@@ -60,10 +60,6 @@ jobs:
             3.10
             3.12
           cache: 'pip'
-      - name: Setup LXD
-        uses: canonical/setup-lxd@v0.1.1
-        with:
-          channel: latest/stable
       - name: Configure environment
         run: |
           echo "::group::apt-get"
@@ -111,10 +107,12 @@ jobs:
           cache: 'pip'
       - name: Setup LXD
         uses: canonical/setup-lxd@v0.1.1
-        with:
-          channel: latest/stable
       - name: Configure environment
         run: |
+          echo "::group::Begin snap install"
+          echo "Installing snaps in the background while running apt and pip..."
+          sudo snap install --no-wait --channel=beta fetch-service
+          echo "::endgroup::"
           echo "::group::apt-get"
           sudo apt update
           sudo apt-get install -y libapt-pkg-dev
@@ -123,6 +121,9 @@ jobs:
           python -m pip install tox
           echo "::endgroup::"
           mkdir -p results
+          echo "::group::Wait for snap to complete"
+          snap watch --last=install
+          echo "::endgroup::"
       - name: Setup Tox environments
         run: tox run -e integration-${{ matrix.python }} --notest
       - name: Integration tests

.pre-commit-config.yaml

@@ -2,7 +2,7 @@
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.6.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
@@ -14,17 +14,17 @@ repos:
       - id: mixed-line-ending
   - repo: https://github.com/charliermarsh/ruff-pre-commit
     # renovate: datasource=pypi;depName=ruff
-    rev: "v0.0.267"
+    rev: "v0.6.3"
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]
   - repo: https://github.com/psf/black
     # renovate: datasource=pypi;depName=black
-    rev: "23.3.0"
+    rev: "24.8.0"
     hooks:
       - id: black
   - repo: https://github.com/adrienverge/yamllint.git
     # renovate: datasource=pypi;depName=yamllint
-    rev: "v1.31.0"
+    rev: "v1.35.1"
     hooks:
       - id: yamllint

craft_application/__init__.py

@@ -25,6 +25,7 @@
     ProviderService,
     ServiceFactory,
 )
+from craft_application._config import ConfigModel
 
 try:
     from ._version import __version__
@@ -42,6 +43,7 @@
     "AppFeatures",
     "AppMetadata",
     "AppService",
+    "ConfigModel",
     "models",
     "ProjectService",
     "LifecycleService",

craft_application/_config.py

@@ -0,0 +1,37 @@
+# This file is part of craft-application.
+#
+# Copyright 2024 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Lesser General Public License version 3, as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranties of MERCHANTABILITY,
+# SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR PURPOSE.
+# See the GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+"""Configuration model for craft applications."""
+from __future__ import annotations
+
+import craft_cli
+import pydantic
+
+
+class ConfigModel(pydantic.BaseModel):
+    """A configuration model for a craft application."""
+
+    verbosity_level: craft_cli.EmitterMode = craft_cli.EmitterMode.BRIEF
+    debug: bool = False
+    build_environment: str | None = None
+    secrets: str
+
+    platform: str | None = None
+    build_for: str | None = None
+
+    parallel_build_count: int
+    max_parallel_build_count: int
+    lxd_remote: str = "local"
+    launchpad_instance: str = "production"