Changes for RK042 - Support for Pro Rocks in Rockcraft - 30/01/25

.github/ISSUE_TEMPLATE/bug.yaml

@@ -58,4 +58,3 @@ body:
       render: shell
     validations:
       required: true
-

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,3 +1,3 @@
 - [ ] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
 
------
+---

.github/labeler.yml

@@ -1,4 +1,4 @@
 # Add 'documentation' label to any changes within 'docs' folder or any subfolders
 documentation:
-- changed-files:
-  - any-glob-to-any-file: docs/**
+  - changed-files:
+      - any-glob-to-any-file: docs/**

.github/release-drafter.yml

@@ -16,7 +16,7 @@ categories:
     label:
       - "tooling"
 
-change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
+change-template: "- $TITLE @$AUTHOR (#$NUMBER)"
 
 template: |
   Special thanks to the contributors that made this release happen: $CONTRIBUTORS

.github/renovate.json5

@@ -6,12 +6,16 @@
     "pydantic-yaml", // Updates with pydantic
     "mcr.microsoft.com/dotnet/runtime-deps", // This is intentionally dotnet 6
   ],
-  labels: ["dependencies"],  // For convenient searching in GitHub
+  labels: ["dependencies"], // For convenient searching in GitHub
   baseBranches: ["$default", "/^hotfix\\/.*/"],
   pip_requirements: {
-    fileMatch: ["^tox.ini$", "(^|/)requirements([\\w-]*)\\.txt$", "^.pre-commit-config.yaml$"]
+    fileMatch: [
+      "^tox.ini$",
+      "(^|/)requirements([\\w-]*)\\.txt$",
+      "^.pre-commit-config.yaml$",
+    ],
   },
-   packageRules: [
+  packageRules: [
     {
       // Internal package minor patch updates get top priority, with auto-merging
       groupName: "internal package minor releases",
@@ -21,7 +25,7 @@
       automerge: true,
       minimumReleaseAge: "0 seconds",
       schedule: ["at any time"],
-      matchBaseBranches: ["$default"],  // Only do minor releases on main
+      matchBaseBranches: ["$default"], // Only do minor releases on main
     },
     {
       // Same as above, but for hotfix branches, only for patch, and without auto-merging.
@@ -31,7 +35,7 @@
       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.
@@ -40,15 +44,15 @@
       excludeDepPatterns: ["lint/.*", "types/.*"],
       matchUpdateTypes: ["patch", "pin", "digest"],
       prPriority: 3, // Patches should go first!
-      automerge: true
+      automerge: true,
     },
     {
       // Update all internal packages in one higher-priority PR
       groupName: "internal packages",
       matchDepPatterns: ["craft-.*", "snap-.*"],
       matchCategories: ["python"],
       prPriority: 2,
-      matchBaseBranches: ["$default"],  // Not for hotfix branches
+      matchBaseBranches: ["$default"], // Not for hotfix branches
     },
     {
       // GitHub Actions are higher priority to update than most dependencies since they don't tend to break things.
@@ -67,11 +71,7 @@
       // Minor changes can be grouped and automerged for dev dependencies, but are also deprioritised.
       groupName: "development dependencies (non-major)",
       groupSlug: "dev-dependencies",
-      matchDepPatterns: [
-        "dev/.*",
-        "lint/.*",
-        "types/.*"
-      ],
+      matchDepPatterns: ["dev/.*", "lint/.*", "types/.*"],
       matchPackagePatterns: [
         // Brought from charmcraft. May not be complete.
         // This helps group dependencies in requirements-dev.txt files.
@@ -96,7 +96,7 @@
       ],
       matchUpdateTypes: ["minor", "patch", "pin", "digest"],
       prPriority: -1,
-      automerge: true
+      automerge: true,
     },
     {
       // Documentation related updates
@@ -105,13 +105,13 @@
       matchPackageNames: ["Sphinx", "furo"],
       matchPackagePatterns: ["[Ss]phinx.*$"],
       matchDepPatterns: ["docs/.*"],
-      matchBaseBranches: ["$default"],  // Not for hotfix branches
+      matchBaseBranches: ["$default"], // Not for hotfix branches
     },
     {
       // Other major dependencies get deprioritised below minor dev dependencies.
       matchUpdateTypes: ["major"],
       prPriority: -2,
-      matchBaseBranches: ["$default"],  // Not for hotfix branches
+      matchBaseBranches: ["$default"], // Not for hotfix branches
     },
     {
       // Major dev dependencies are stone last, but grouped.
@@ -120,7 +120,7 @@
       matchDepTypes: ["devDependencies"],
       matchUpdateTypes: ["major"],
       prPriority: -3,
-      matchBaseBranches: ["$default"],  // Not for hotfix branches
+      matchBaseBranches: ["$default"], // Not for hotfix branches
       matchPackagePatterns: [
         // Generated from the dependency dashboard, may not be complete.
         "^(.*/)?autoflake$",
@@ -135,16 +135,16 @@
         "^(.*/)?responses$",
         "^(.*/)?ruff$",
         "^(.*/)?twine$",
-        "^(.*/)?types-"
+        "^(.*/)?types-",
       ],
     },
     {
       // Pyright makes regular breaking changes in patch releases, so we separate these
       // and do them independently.
       matchPackageNames: ["pyright", "types/pyright"],
       prPriority: -4,
-      matchBaseBranches: ["$default"],  // Not for hotfix branches
-    }
+      matchBaseBranches: ["$default"], // Not for hotfix branches
+    },
   ],
   customManagers: [
     {
@@ -153,8 +153,8 @@
       customType: "regex",
       depTypeTemplate: "devDependencies",
       matchStrings: [
-        "# renovate: datasource=(?<datasource>\\S+)\n\\s+(?<depName>.*?)(\\[[\\w]*\\])*[=><]=?(?<currentValue>.*?)\n"
-      ]
+        "# renovate: datasource=(?<datasource>\\S+)\n\\s+(?<depName>.*?)(\\[[\\w]*\\])*[=><]=?(?<currentValue>.*?)\n",
+      ],
     },
     {
       // .pre-commit-config.yaml version updates
@@ -163,9 +163,9 @@
       datasourceTemplate: "pypi",
       depTypeTemplate: "lint",
       matchStrings: [
-        "- repo: .*/<(?<depName>\\S+)\\s*\\n\\s*rev:\s+\"?v?(?<currentValue>\\S*)\"?",
-      ]
-    }
+        '- repo: .*/<(?<depName>\\S+)\\s*\\n\\s*rev:\s+"?v?(?<currentValue>\\S*)"?',
+      ],
+    },
   ],
   timezone: "Etc/UTC",
   schedule: ["every weekend"],
@@ -176,5 +176,5 @@
   prHourlyLimit: 1, // No more than 1 PR per hour.
   minimumReleaseAge: "2 days",
   automergeStrategy: "squash", // Squash & rebase when auto-merging.
-  semanticCommitType: "build"  // use `build` as commit header type (i.e. `build(deps): <description>`)
+  semanticCommitType: "build", // use `build` as commit header type (i.e. `build(deps): <description>`)
 }

.github/workflows/policy.yaml

@@ -0,0 +1,21 @@
+name: Check policy
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+      - hotfix/*
+      - work/check-policy # For development
+
+jobs:
+  policy:
+    uses: canonical/starflow/.github/workflows/policy.yaml@main
+  python-scans:
+    name: Security scan
+    uses: canonical/starflow/.github/workflows/scan-python.yaml@main
+    with:
+      packages: python-apt-dev
+      # requirements-noble.txt can't build on jammy
+      requirements-find-args: "! -name requirements-noble.txt"
+      osv-extra-args: "--config=source/osv-scanner.toml"
+      uv-export: false

.github/workflows/qa.yaml

@@ -0,0 +1,18 @@
+name: QA
+on:
+  push:
+    branches:
+      - "main"
+      - "feature/*"
+      - "hotfix/*"
+      - "release/*"
+      - "renovate/*"
+  pull_request:
+
+jobs:
+  lint:
+    uses: canonical/starflow/.github/workflows/lint-python.yaml@main
+  test:
+    uses: canonical/starflow/.github/workflows/test-python.yaml@main
+    with:
+      lowest-python-version: ""

.github/workflows/schema.yaml

@@ -6,24 +6,30 @@ env:
 
 jobs:
   diff-schema:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
 
     steps:
       - name: Checkout rockcraft
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
+      - name: Set up uv with caching
+        id: setup-uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+          cache-suffix: ${{ steps.runner-info.outputs.cache-hash }}
+
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
           python-version: "3.10"
 
-      - name: Install requirements
-        run: pip install -r requirements.txt
-
       - name: Run generator script
-        run: ./tools/schema/schema.py > generated_schema.json
+        run: |
+          uv run --frozen --no-dev --extra apt-jammy \
+            python tools/schema/schema.py > generated_schema.json
 
       - name: Check with stored schema
         run: |
@@ -49,4 +55,6 @@ jobs:
 
       - name: Run ajv
         run: |
-          ajv validate -s $ROCKCRAFT_JSON -d docs/reference/code/example/rockcraft.yaml --strict=false --spec=draft2020
+          ajv validate -s $ROCKCRAFT_JSON \
+            -d docs/reference/code/example/rockcraft.yaml \
+            --strict=false --spec=draft2020

.github/workflows/snap.yaml

@@ -6,7 +6,6 @@ on:
     branches:
       - "feature/**"
 
-
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -32,7 +31,7 @@ jobs:
         run: |
           if [[ "${{ github.event_name }}" == "pull_request" ]]
           then
-            echo "branch=pr-${{ github.event.number }}" >> "$GITHUB_OUTPUT"            
+            echo "branch=pr-${{ github.event.number }}" >> "$GITHUB_OUTPUT"
           else
             branch=$(echo ${GITHUB_REF#refs/*/} | sed -e 's|feature/\(.*\)|\1|')
             echo "branch=$branch" >> "$GITHUB_OUTPUT"

.github/workflows/spread-manual.yaml

@@ -1,7 +1,7 @@
 name: Spread (manual - large/flaky)
 on:
   pull_request:
-    types: [ labeled ]
+    types: [labeled]
   schedule:
     - cron: "0 2 * * 0,3" # run at 2 AM on Sundays and Wednesdays
 
@@ -43,9 +43,15 @@ jobs:
         with:
           name: snap
           path: tests
-      - name: Run spread (large/flaky)
+
+      - name: Run remote-build tests
+        env:
+          LAUNCHPAD_TOKEN: "${{ secrets.LAUNCHPAD_TOKEN }}"
+        run: spread tests/spread/rockcraft/remote-build
+      - name: Run large/flaky tests
+        id: flaky
         run: spread tests/spread/manual/
-        
+
       - name: Discard spread workers
         if: always()
         run: |

.github/workflows/spread.yaml

@@ -52,4 +52,4 @@ jobs:
           shopt -s nullglob
           for r in .spread-reuse.*.yaml; do
             spread -discard -reuse-pid="$(echo "$r" | grep -o -E '[0-9]+')"
-          done
+          done