Merge branch 'v0.x.x' into update_metric_info

Signed-off-by: flora-hofmann-frequenz <[email protected]>

Author: flora-hofmann-frequenz

.github/containers/test-installation/Dockerfile

@@ -13,5 +13,8 @@ RUN apt-get update -y && \
     python -m pip install --upgrade --no-cache-dir pip
 
 COPY dist dist
-RUN pip install dist/*.whl && \
-    rm -rf dist
+# This git-credentials file is made available by the GitHub ci.yaml workflow
+COPY git-credentials /root/.git-credentials
+RUN git config --global credential.helper store && \
+    pip install dist/*.whl && \
+    rm -rf dist /root/.git-credentials

.github/workflows/ci.yaml

@@ -41,6 +41,9 @@ jobs:
     runs-on: ${{ matrix.os }}
 
     steps:
+      - name: Setup Git
+        uses: frequenz-floss/[email protected]
+
       - name: Print environment (debug)
         run: env
 
@@ -88,10 +91,14 @@ jobs:
     # The job name should match the name of the `nox` job.
     name: Test with nox
     needs: ["nox"]
+    # We skip this job only if nox was also skipped
+    if: always() && needs.nox.result != 'skipped'
     runs-on: ubuntu-20.04
+    env:
+      DEPS_RESULT: ${{ needs.nox.result }}
     steps:
-      - name: Return true
-        run: "true"
+      - name: Check matrix job result
+        run: test "$DEPS_RESULT" = "success"
 
   nox-cross-arch:
     name: Cross-arch tests with nox
@@ -115,6 +122,9 @@ jobs:
     runs-on: ${{ matrix.os }}
 
     steps:
+      - name: Setup Git
+        uses: frequenz-floss/[email protected]
+
       - name: Fetch sources
         uses: actions/checkout@v4
 
@@ -137,7 +147,7 @@ jobs:
           key: ${{ runner.os }}-buildx-nox-${{ matrix.arch }}-${{ matrix.os }}-${{ matrix.python }}
 
       - name: Build image
-        uses: docker/build-push-action@v5
+        uses: docker/build-push-action@v6
         with:
           context: .github/containers/nox-cross-arch
           file: .github/containers/nox-cross-arch/${{ matrix.arch }}-${{ matrix.os }}-python-${{ matrix.python }}.Dockerfile
@@ -200,15 +210,22 @@ jobs:
     # The job name should match the name of the `nox-cross-arch` job.
     name: Cross-arch tests with nox
     needs: ["nox-cross-arch"]
+    # We skip this job only if nox-cross-arch was also skipped
+    if: always() && needs.nox-cross-arch.result != 'skipped'
     runs-on: ubuntu-20.04
+    env:
+      DEPS_RESULT: ${{ needs.nox-cross-arch.result }}
     steps:
-      - name: Return true
-        run: "true"
+      - name: Check matrix job result
+        run: test "$DEPS_RESULT" = "success"
 
   build:
     name: Build distribution packages
     runs-on: ubuntu-20.04
     steps:
+      - name: Setup Git
+        uses: frequenz-floss/[email protected]
+
       - name: Fetch sources
         uses: actions/checkout@v4
         with:
@@ -241,19 +258,31 @@ jobs:
     needs: ["build"]
     runs-on: ubuntu-20.04
     steps:
+      - name: Setup Git
+        uses: frequenz-floss/[email protected]
+
       - name: Fetch sources
         uses: actions/checkout@v4
+
       - name: Download package
         uses: actions/download-artifact@v4
         with:
           name: dist-packages
           path: dist
+
+      - name: Make Git credentials available to docker
+        run: |
+          touch ~/.git-credentials  # Ensure the file exists
+          cp ~/.git-credentials git-credentials || true
+
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
+
       - name: Set up docker-buildx
         uses: docker/setup-buildx-action@v3
+
       - name: Test Installation
-        uses: docker/build-push-action@v5
+        uses: docker/build-push-action@v6
         with:
           context: .
           file: .github/containers/test-installation/Dockerfile
@@ -266,14 +295,14 @@ jobs:
     if: github.event_name != 'push'
     runs-on: ubuntu-20.04
     steps:
+      - name: Setup Git
+        uses: frequenz-floss/[email protected]
+
       - name: Fetch sources
         uses: actions/checkout@v4
         with:
           submodules: true
 
-      - name: Setup Git user and e-mail
-        uses: frequenz-floss/setup-git-user@v2
-
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
@@ -308,14 +337,14 @@ jobs:
     permissions:
       contents: write
     steps:
+      - name: Setup Git
+        uses: frequenz-floss/[email protected]
+
       - name: Fetch sources
         uses: actions/checkout@v4
         with:
           submodules: true
 
-      - name: Setup Git user and e-mail
-        uses: frequenz-floss/setup-git-user@v2
-
       - name: Set up Python
         uses: actions/setup-python@v5
         with:

.github/workflows/release-notes-check.yml

@@ -20,7 +20,7 @@ jobs:
     steps:
       - name: Check for a release notes update
         if: github.event_name == 'pull_request'
-        uses: brettcannon/check-for-changed-files@4170644959a21843b31f1181f2a1761d65ef4791 # v1.2.0
+        uses: brettcannon/check-for-changed-files@871d7b8b5917a4f6f06662e2262e8ffc51dff6d1 # v1.2.1
         with:
           # TODO(cookiecutter): Uncomment the following line for private repositories, otherwise remove it and remove it
           # token: ${{ secrets.github_token }}

RELEASE_NOTES.md

@@ -6,24 +6,12 @@
 
 ## Upgrading
 
-<<<<<<< HEAD
-* Upgrading metric `__init__` to names from api-common release [v0.6.0](https://github.com/frequenz-floss/frequenz-api-common/releases/tag/v0.6.0)
-
-## New Features
-
-<!-- Here goes the main new features and examples or instructions on how to use them -->
-=======
 <!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
 
 ## New Features
 
 * Additional information for energy metric
->>>>>>> fd64a93 (Add additional info to inform energy metric users)
 
 ## Bug Fixes
 
 <!-- Here goes notable bug fixes that are worth a special mention or explanation -->
-<<<<<<< HEAD
-=======
-
->>>>>>> fd64a93 (Add additional info to inform energy metric users)

mkdocs.yml

@@ -97,7 +97,7 @@ plugins:
   - literate-nav:
       nav_file: SUMMARY.md
   - mike:
-      alias_type: redirect
+      alias_type: symlink
       canonical_version: latest
   - mkdocstrings:
       default_handler: python
@@ -114,6 +114,7 @@ plugins:
             show_root_members_full_path: true
             show_signature_annotations: true
             show_source: true
+            show_symbol_type_toc: true
             signature_crossrefs: true
           import:
             # TODO(cookiecutter): You might want to add other external references here

pyproject.toml

@@ -5,7 +5,7 @@
 requires = [
   "setuptools == 68.1.0",
   "setuptools_scm[toml] == 7.1.0",
-  "frequenz-repo-config[lib] == 0.9.1",
+  "frequenz-repo-config[lib] == 0.10.0",
 ]
 build-backend = "setuptools.build_meta"
 
@@ -27,7 +27,7 @@ classifiers = [
 requires-python = ">= 3.11, < 4"
 dependencies = [
   "typing-extensions >= 4.5.0, < 5",
-  "frequenz-api-common >= 0.5.4, < 6",
+  "frequenz-api-common >= 0.6.0, < 7",
 ]
 dynamic = ["version"]
 
@@ -37,44 +37,45 @@ email = "[email protected]"
 
 [project.optional-dependencies]
 dev-flake8 = [
-  "flake8 == 7.0.0",
+  "flake8 == 7.1.0",
   "flake8-docstrings == 1.7.0",
   "flake8-pyproject == 1.2.3",  # For reading the flake8 config from pyproject.toml
-  "pydoclint == 0.4.1",
+  "pydoclint == 0.5.6",
   "pydocstyle == 6.3.0",
 ]
 dev-formatting = ["black == 24.4.2", "isort == 5.13.2"]
 dev-mkdocs = [
   "black == 24.4.2",
   "Markdown==3.6",
-  "mike == 2.0.0",
+  "mike == 2.1.2",
   "mkdocs-gen-files == 0.5.0",
   "mkdocs-literate-nav == 0.6.1",
   "mkdocs-macros-plugin == 1.0.5",
-  "mkdocs-material == 9.5.20",
-  "mkdocstrings[python] == 0.25.0",
-  "frequenz-repo-config[lib] == 0.9.1",
+  "mkdocs-material == 9.5.30",
+  "mkdocstrings[python] == 0.25.2",
+  "mkdocstrings-python == 1.9.2",
+  "frequenz-repo-config[lib] == 0.10.0",
 ]
 dev-mypy = [
-  "mypy == 1.10.0",
+  "mypy == 1.11.1",
   "types-Markdown == 3.6.0.20240316",
   # For checking the noxfile, docs/ script, and tests
   "frequenz-client-common[dev-mkdocs,dev-noxfile,dev-pytest]",
 ]
 dev-noxfile = [
   "nox == 2024.4.15",
-  "frequenz-repo-config[lib] == 0.9.1",
+  "frequenz-repo-config[lib] == 0.10.0",
 ]
 dev-pylint = [
-  "pylint == 3.1.0",
+  "pylint == 3.2.6",
   # For checking the noxfile, docs/ script, and tests
   "frequenz-client-common[dev-mkdocs,dev-noxfile,dev-pytest]",
 ]
 dev-pytest = [
-  "pytest == 8.2.0",
-  "frequenz-repo-config[extra-lint-examples] == 0.9.1",
+  "pytest == 8.3.2",
+  "frequenz-repo-config[extra-lint-examples] == 0.10.0",
   "pytest-mock == 3.14.0",
-  "pytest-asyncio == 0.23.6",
+  "pytest-asyncio == 0.23.8",
   "async-solipsism == 0.6",
 ]
 dev = [
@@ -131,10 +132,14 @@ disable = [
   # pylint's unsubscriptable check is buggy and is not needed because
   # it is a type-check, for which we already have mypy.
   "unsubscriptable-object",
+  # Checked by mypy
+  "no-member",
   # Checked by flake8
+  "f-string-without-interpolation",
   "redefined-outer-name",
   "unused-import",
   "line-too-long",
+  "missing-function-docstring",
   "unused-variable",
   "unnecessary-lambda-assignment",
 ]