chore(merge): 'main' into 'IENG-860'

canonical · Apr 9, 2024 · 849dbfe · 849dbfe
2 parents 76df76b + 429a69c
commit 849dbfe
Show file tree

Hide file tree

Showing 329 changed files with 12,007 additions and 2,185 deletions.
diff --git a/.github/workflows/spread-scheduled.yaml b/.github/workflows/spread-scheduled.yaml
@@ -26,7 +26,7 @@ jobs:
           sudo snap install --dangerous --classic ${{ steps.snapcraft.outputs.snap }}
 
   kernel-plugins:
-    runs-on: self-hosted
+    runs-on: [spread-installed]
     needs: [snap-build]
     strategy:
       fail-fast: false
@@ -51,8 +51,37 @@ jobs:
         run: |
           spread google:ubuntu-22.04-64:tests/spread/plugins/${{ matrix.type }}/kernel
 
+  remote-build-core24:
+    runs-on: [spread-installed]
+    needs: [snap-build]
+    strategy:
+      fail-fast: false
+      matrix:
+        system:
+          - ubuntu-24.04-64
+    steps:
+      - name: Cleanup job workspace
+        run: |
+          rm -rf "${{ github.workspace }}"
+          mkdir "${{ github.workspace }}"
+      - name: Checkout snapcraft
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          submodules: true
+      - name: Download snap artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: snap
+          path: tests
+      - name: remote-build test
+        env:
+          LAUNCHPAD_TOKEN: "${{ secrets.LAUNCHPAD_TOKEN }}"
+        run: |
+          spread google:${{ matrix.system }}:tests/spread/core24/remote-build
+
   remote-build:
-    runs-on: self-hosted
+    runs-on: [spread-installed]
     needs: [snap-build]
     strategy:
       fail-fast: false

diff --git a/.github/workflows/spread.yml b/.github/workflows/spread.yml
@@ -27,7 +27,7 @@ jobs:
           sudo snap install --dangerous --classic ${{ steps.build-snapcraft.outputs.snap }}
 
   integration-spread-tests:
-    runs-on: self-hosted
+    runs-on: [spread-installed]
     needs: build
     strategy:
       # FIXME: enable fail-fast mode once spread can cancel an executing job.
@@ -40,6 +40,7 @@ jobs:
         spread-jobs:
           - google:ubuntu-20.04-64
           - google:ubuntu-22.04-64
+          - google:ubuntu-24.04-64
 
     steps:
       - name: Checkout snapcraft
@@ -69,7 +70,7 @@ jobs:
           done
 
   integration-spread-tests-store:
-    runs-on: self-hosted
+    runs-on: [spread-installed]
     needs: build
     strategy:
       # FIXME: enable fail-fast mode once spread can cancel an executing job.

diff --git a/.gitignore b/.gitignore
@@ -27,6 +27,7 @@ pip-wheel-metadata/
 *.pyc
 __pycache__
 .pytest_cache
+*.comp
 *.snap
 snap/.snapcraft/
 .spread-reuse.*

diff --git a/.shellcheckrc b/.shellcheckrc
@@ -0,0 +1,5 @@
+# NOTE: these disables are only necessary while the core24 spread tests are
+# being fixed; they refer to unreachable code, unused variable, etc.
+# This file must be removed once all tests in tests/spread/core24/ are fixed.
+disable=SC2317,SC2034,SC2154
+
diff --git a/docs/.sphinx/pinned-requirements.txt b/docs/.sphinx/pinned-requirements.txt
@@ -1,4 +1,4 @@
-alabaster==0.7.13
+alabaster==0.7.16
 Babel==2.11.0
 beautifulsoup4==4.11.1
 certifi==2023.7.22
@@ -10,7 +10,7 @@ idna==3.4
 imagesize==1.4.1
 Jinja2==3.1.3
 livereload==2.6.3
-MarkupSafe==2.1.3
+MarkupSafe==2.1.5
 packaging==23.2
 pyenchant==3.2.2
 Pygments==2.15.0

diff --git a/docs/conf.py b/docs/conf.py
@@ -1,4 +1,5 @@
 import datetime
+import logging
 import os
 import pathlib
 import sys
@@ -179,19 +180,18 @@
     (
         # Excluded because Snapcraft doesn't use overlays
         "common/craft-parts/overlay_parameters.rst",
-        # Excluded here because they are included explicitly in other documents;
-        # if we don't exclude them, they generate "duplicate label" errors.
-        "common/craft-parts/dump_plugin.rst",
-        "common/craft-parts/part_properties.rst",
-        "common/craft-parts/python_plugin.rst",
-        "common/craft-parts/rust_plugin.rst",
-        "common/craft-parts/step_execution_environment.rst",
-        "common/craft-parts/step_output_directories.rst",
-        "common/craft-parts/explanation/filesets.rst",
-        "common/craft-parts/explanation/lifecycle.rst",
-        "common/craft-parts/explanation/parts.rst",
-        "common/craft-parts/explanation/how_parts_are_built.rst",
+        # Excluded here because they are either included explicitly in other
+        # documents (so they generate "duplicate label" errors) or they aren't
+        # used in this documentation at all (so they generate "unreferenced"
+        # errors).
+        "common/craft-parts/explanation/overlay_parameters.rst",
+        "common/craft-parts/explanation/overlays.rst",
+        "common/craft-parts/how-to/craftctl.rst",
         "common/craft-parts/reference/parts_steps.rst",
+        "common/craft-parts/reference/step_execution_environment.rst",
+        "common/craft-parts/reference/step_output_directories.rst",
+        "common/craft-parts/reference/plugins/python_plugin.rst",
+        "common/craft-parts/reference/plugins/maven_plugin.rst",
         # Extra non-craft-parts exclusions can be added after this comment
     )
 )
@@ -208,7 +208,7 @@ def setup(app):
 
 # Setup libraries documentation snippets for use in snapcraft docs.
 common_docs_path = pathlib.Path(__file__).parent / "common"
-craft_parts_docs_path = pathlib.Path(craft_parts_docs.__file__).parent
+craft_parts_docs_path = pathlib.Path(craft_parts_docs.__file__).parent / "craft-parts"
 (common_docs_path / "craft-parts").unlink(missing_ok=True)
 (common_docs_path / "craft-parts").symlink_to(
     craft_parts_docs_path, target_is_directory=True

diff --git a/docs/explanation/filesets.rst b/docs/explanation/filesets.rst
diff --git a/docs/explanation/how_parts_are_built.rst b/docs/explanation/how_parts_are_built.rst
diff --git a/docs/explanation/index.rst b/docs/explanation/index.rst
@@ -7,6 +7,8 @@ Explanation
    :maxdepth: 1
 
    architectures
-   filesets
-   parts
-   lifecycle
+   /common/craft-parts/explanation/filesets
+   /common/craft-parts/explanation/parts
+   /common/craft-parts/explanation/how_parts_are_built
+   /common/craft-parts/explanation/lifecycle
+   /common/craft-parts/explanation/dump_plugin
diff --git a/docs/explanation/lifecycle.rst b/docs/explanation/lifecycle.rst
diff --git a/docs/explanation/parts.rst b/docs/explanation/parts.rst
diff --git a/docs/howto/index.rst b/docs/howto/index.rst
@@ -7,3 +7,5 @@ How-to guides
    :maxdepth: 1
 
    architectures
+   /common/craft-parts/how-to/include_files
+   /common/craft-parts/how-to/override_build
diff --git a/docs/images/lifecycle_logic.png b/docs/images/lifecycle_logic.png
diff --git a/docs/reference/index.rst b/docs/reference/index.rst
@@ -9,7 +9,7 @@ Reference
    architectures
    commands
    plugins
-   part_properties
+   /common/craft-parts/reference/part_properties
    parts_steps
 
 Indices and tables

diff --git a/docs/reference/part_properties.rst b/docs/reference/part_properties.rst
diff --git a/docs/reference/parts_steps.rst b/docs/reference/parts_steps.rst
@@ -1,6 +1,6 @@
 
 .. include:: /common/craft-parts/reference/parts_steps.rst
 
-.. include:: /common/craft-parts/step_execution_environment.rst
+.. include:: /common/craft-parts/reference/step_execution_environment.rst
 
-.. include:: /common/craft-parts/step_output_directories.rst
+.. include:: /common/craft-parts/reference/step_output_directories.rst
diff --git a/docs/reference/plugins.rst b/docs/reference/plugins.rst
@@ -10,6 +10,7 @@ Snapcraft.
 .. toctree::
    :maxdepth: 1
 
-   plugins/dump_plugin
+   /common/craft-parts/reference/plugins/dump_plugin
+   plugins/maven_plugin
    plugins/python_plugin
-   plugins/rust_plugin
+   /common/craft-parts/reference/plugins/rust_plugin
diff --git a/docs/reference/plugins/dump_plugin.rst b/docs/reference/plugins/dump_plugin.rst
diff --git a/docs/reference/plugins/maven_plugin.rst b/docs/reference/plugins/maven_plugin.rst
@@ -0,0 +1,37 @@
+
+.. include:: /common/craft-parts/reference/plugins/maven_plugin.rst
+   :end-before: .. _maven-details-begin:
+
+Dependencies
+------------
+
+The plugin expects Maven to be available on the system as the ``mvn``
+executable, unless a part named ``maven-deps`` is defined. In this
+case, the plugin will assume that this part will stage the ``mvn``
+executable to be used in the build step.
+
+Note that the Maven plugin does not make a Java runtime available in
+the target environment. In Snapcraft, the developer must stage the
+appropriate packages in order to be able to execute the application
+(unless the Java runtime is provided by a
+content snap).
+
+
+Example
+-------
+
+This is an example of a Snapcraft part using the Maven plugin. Note
+that the Maven and Java Runtime packages are listed as build packages,
+and the Java Runtime is staged to be part of the final payload::
+
+  mkpass:
+    plugin: maven
+    source: .
+    build-packages:
+      - openjdk-11-jre-headless
+      - maven
+    stage-packages:
+      - openjdk-11-jre-headless
+
+.. include:: /common/craft-parts/reference/plugins/maven_plugin.rst
+   :start-after: .. _maven-details-end:
diff --git a/docs/reference/plugins/python_plugin.rst b/docs/reference/plugins/python_plugin.rst
@@ -1,5 +1,5 @@
 
-.. include:: /common/craft-parts/python_plugin.rst
+.. include:: /common/craft-parts/reference/plugins/python_plugin.rst
    :end-before: .. _python-details-begin:
 
 Dependencies
@@ -19,5 +19,5 @@ Whether the Python interpreter needs to be included in the snap depends on its
 Snapcraft will prefer an included interpreter over the base's, even for projects
 with ``strict`` and ``devmode`` confinement.
 
-.. include:: /common/craft-parts/python_plugin.rst
+.. include:: /common/craft-parts/reference/plugins/python_plugin.rst
    :start-after: .. _python-details-end:
diff --git a/docs/reference/plugins/rust_plugin.rst b/docs/reference/plugins/rust_plugin.rst
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,21 +1,21 @@
 attrs==23.1.0
 catkin-pkg==0.5.2
 click==8.1.7
-craft-application==1.2.1
+craft-application==2.4.0
 craft-archives==1.1.3
 craft-cli==2.5.1
 craft-grammar==1.1.1
-craft-parts==1.27.0
+craft-parts==1.29.0
 craft-providers==1.23.1
-craft-store==2.5.0
+craft-store==2.6.1
 Deprecated==1.2.14
 distro==1.8.0
 gnupg==2.3.1
 httplib2==0.22.0
 jsonpointer==2.3
 jsonschema==2.5.1
 launchpadlib==1.11.0
-lazr.restfulclient==0.14.5
+lazr.restfulclient==0.14.6
 lazr.uri==1.0.6
 mypy-extensions==1.0.0
 oauthlib==3.2.2
@@ -24,12 +24,12 @@ platformdirs==3.11.0
 polib==1.1.1
 progressbar==2.5
 protobuf==3.20.3
-psutil==5.9.6
-pydantic==1.10.13
+psutil==5.9.8
+pydantic==1.10.14
 pydantic-yaml==0.11.2
 pyelftools==0.29
 pygit2==1.13.3
-pylxd==2.3.1
+pylxd==2.3.2
 python-debian==0.1.49
 pyxdg==0.28
 PyYAML==6.0.1