many: merge starbase/main

.editorconfig

@@ -0,0 +1,43 @@
+# Editor configuration options.
+# See: https://spec.editorconfig.org/
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+max_line_length = 80
+trim_trailing_whitespace = true
+
+[.editorconfig]
+max_line_length = off
+
+[Makefile]
+indent_style = tab
+
+[{*.py,*.pyi}]
+max_line_length = 88
+
+[{*.bash,*.sh,*.zsh}]
+indent_size = 2
+tab_width = 2
+
+[{*.har,*.json,*.json5}]
+indent_size = 2
+max_line_length = off
+
+[{*.markdown,*.md,*.rst}]
+max_line_length = off
+ij_visual_guides = none
+
+[{*.toml,Cargo.lock,Cargo.toml.orig,Gopkg.lock,Pipfile,poetry.lock}]
+max_line_length = off
+
+[{*.ini, *.cfg}]
+max_line_length = off
+
+[{*.yaml,*.yml}]
+indent_size = 2
+max_line_length = off

.github/release-drafter.yaml

@@ -18,7 +18,7 @@ categories:
 change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
 template: |
   Special thanks to the contributors that made this release happen: $CONTRIBUTORS
-  
+
   ## Full list of changes
 
   $CHANGES

.github/renovate.json5

@@ -1,18 +1,16 @@
- {
+{
   // Configuration file for RenovateBot: https://docs.renovatebot.com/configuration-options
   extends: ["config:base"],
   labels: ["dependencies"],  // For convenient searching in GitHub
   pip_requirements: {
-    fileMatch: ["^tox.ini$"]
-  },
-  pip_setup: {
-    fileMatch: ["^pyproject.toml$", "(^|/)setup\\.py$"]
+    fileMatch: ["^tox.ini$", "(^|/)requirements([\\w-]*)\\.txt$"]
   },
    packageRules: [
     {
       // Automerge patches, pin changes and digest changes.
       // Also groups these changes together.
-      groupName: "patch updates",
+      groupName: "bugfixes",
+      excludePackagePrefixes: ["dev", "lint", "types"],
       matchUpdateTypes: ["patch", "pin", "digest"],
       prPriority: 3, // Patches should go first!
       automerge: true
@@ -28,28 +26,50 @@
       // GitHub Actions are higher priority to update than most dependencies.
       groupName: "GitHub Actions",
       matchManagers: ["github-actions"],
-      prPriority: 1
+      prPriority: 1,
+      automerge: true,
     },
     // Everything not in one of these rules gets priority 0 and falls here.
     {
       // Minor changes can be grouped and automerged for dev dependencies, but are also deprioritised.
-      groupName: "development dependencies (minor and patch)",
+      groupName: "development dependencies (non-major)",
       groupSlug: "dev-dependencies",
-      matchDepTypes: ["devDependencies"],
+      matchPackagePrefixes: [
+        "dev",
+        "lint",
+        "types"
+      ],
+      excludePackagePatterns: ["ruff"],
       matchUpdateTypes: ["minor", "patch", "pin", "digest"],
       prPriority: -1,
       automerge: true
     },
+    {
+      // Documentation related updates
+      groupName: "documentation dependencies",
+      groupSlug: "doc-dependencies",
+      matchPackageNames: ["Sphinx"],
+      matchPackagePatterns: ["^[Ss]phinx.*$", "^furo$"],
+      matchPackagePrefixes: ["docs"],
+    },
     {
       // Other major dependencies get deprioritised below minor dev dependencies.
       matchUpdateTypes: ["major"],
       prPriority: -2
     },
     {
-      // Major dev dependencies are stone last.
+      // Major dev dependencies are stone last, but grouped.
+      groupName: "development dependencies (major versions)",
+      groupSlug: "dev-dependencies",
       matchDepTypes: ["devDependencies"],
       matchUpdateTypes: ["major"],
       prPriority: -3
+    },
+    {
+      // Ruff is still unstable, so update it separately.
+      groupName: "ruff",
+      matchPackagePatterns: ["^(lint/)?ruff$"],
+      prPriority: -3
     }
   ],
   regexManagers: [
@@ -58,14 +78,22 @@
       fileMatch: ["tox.ini"],
       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
+      fileMatch: [".pre-commit-config.yaml"],
+      depTypeTemplate: "devDependencies",
+      matchStrings: [
+        "# renovate: datasource=(?<datasource>\\S+);\\s*depName=(?<depName>.*?)\n\s+rev: \"v?(?<currentValue>.*?)\""
       ]
     }
   ],
   timezone: "Etc/UTC",
-  automergeSchedule: "before 7 am",
+  automergeSchedule: "every weekend",
   schedule: "every weekend",
-  prConcurrentLimit: 5, // No more than 5 open PRs at a time.
+  prConcurrentLimit: 2, // No more than 2 open PRs at a time.
   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.

.github/workflows/docs.yaml

@@ -1,5 +1,11 @@
 name: Documentation
 on:
+  push:
+    branches:
+      - "main"
+      - "feature/*"
+      - "hotfix/*"
+      - "release/*"
   pull_request:
     paths:
       - "docs/**"

.github/workflows/release-drafter.yaml

@@ -4,7 +4,7 @@ on:
   push:
     # branches to consider in the event; optional, defaults to all
     branches:
-      - master
+      - main
 
 jobs:
   update_release_draft:
@@ -17,6 +17,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Release Drafter
-        uses: release-drafter/release-drafter@v5
+        uses: release-drafter/release-drafter@v5.23.0
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/tests.yaml

@@ -72,7 +72,7 @@ jobs:
           directory: ./results/
           files: coverage*.xml
       - name: Upload test results
-        if: always()
+        if: success() || failure()
         uses: actions/upload-artifact@v3
         with:
           name: test-results-${{ matrix.platform }}

.gitignore

@@ -133,3 +133,6 @@ dmypy.json
 
 # Test results
 /results/
+
+# direnv
+.envrc

.pre-commit-config.yaml

@@ -0,0 +1,30 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: fix-byte-order-marker
+      - id: mixed-line-ending
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    # renovate: datasource=pypi;depName=ruff
+    rev: "v0.0.267"
+    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"
+    hooks:
+      - id: black
+  - repo: https://github.com/adrienverge/yamllint.git
+    # renovate: datasource=pypi;depName=yamllint
+    rev: "v1.31.0"
+    hooks:
+      - id: yamllint

.readthedocs.yaml

@@ -0,0 +1,27 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF
+formats:
+  - pdf
+  - epub
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3"
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

.yamlignore

@@ -0,0 +1 @@
+.git/

.yamllint.yaml

@@ -0,0 +1,12 @@
+---
+ignore-from-file: [.gitignore, .yamlignore]
+
+extends: default
+
+rules:
+  document-start: disable
+  float-values: enable
+  line-length: disable
+  octal-values: enable
+  truthy:
+    check-keys: false

HACKING.rst

@@ -16,6 +16,7 @@ We use a large number of tools for our project. Most of these are installed for
 - tox_ version 4 or later. (3.8+ will automatically provision a v4 virtualenv)
 - Pyright_ (it's recommended you install with ``snap install --classic pyright``)
 - ShellCheck_  (also available via snap: ``snap install shellcheck``)
+- pre-commit_
 
 Once you have all of those installed, you can install the necessary virtual environments for this repository using tox.
 
@@ -44,10 +45,33 @@ If you'd like to run the tests with a newer version of Python, you can pass a sp
 
     tox -e test-py310
 
+While the use of pre-commit_ is optional, it is highly encouraged, as it runs automatic fixes for files when `git commit` is called, including code formatting with ``black`` and ``ruff``.  The versions available in ``apt`` from Debian 11 (bullseye), Ubuntu 22.04 (jammy) and newer are sufficient, but you can also install the latest with ``pip install pre-commit``. Once you've installed it, run ``pre-commit install`` in this git repository to install the pre-commit hooks.
+
+Tox environments and labels
+###########################
+
+We group tox environments with the following labels:
+
+* ``format``: Runs all code formatters with auto-fixing
+* ``type``: Runs all type checkers
+* ``lint``: Runs all linters (including type checkers)
+* ``unit-tests``: Runs unit tests in Python versions on supported LTS's + latest
+* ``integration-tests``: Same as above but for integration tests
+* ``tests``: The union of ``unit-tests`` and ``integration-tests``
+
+For each of these, you can see which environments will be run with ``tox list``. For example:
+
+    tox list -m lint
+
+You can also see all the environments by simply running ``tox list``
+
+Running ``tox run -m format`` and ``tox run -m lint`` before committing code is recommended.
+
 .. _Black: https://black.readthedocs.io
 .. _`Canonical contributor licence agreement`: http://www.ubuntu.com/legal/contributors/
 .. _deadsnakes: https://launchpad.net/~deadsnakes/+archive/ubuntu/ppa
 .. _`git submodules`: https://git-scm.com/book/en/v2/Git-Tools-Submodules#_cloning_submodules
+.. _pre-commit: https://pre-commit.com/
 .. _pyproject.toml: ./pyproject.toml
 .. _Pyright: https://github.com/microsoft/pyright
 .. _pytest: https://pytest.org

README.rst

@@ -1 +1 @@
-TODO for craft-archives
+TODO for craft-archives

docs/reference/repo_properties.rst

@@ -144,6 +144,7 @@ UCA repository using "cloud" property
 -------------------------------------
 
 .. code-block:: yaml
+
    package-repositories:
      - type: apt
        cloud: antelope
@@ -152,6 +153,7 @@ UCA repository using "pocket" property
 --------------------------------------
 
 .. code-block:: yaml
+
    package-repositories:
      - type: apt
        cloud: antelope