Update repo-config to v0.6.2

Signed-off-by: TalweSingh <[email protected]>

Author: TalweSingh

.cookiecutter-replay.json

@@ -1,9 +1,9 @@
 {
   "cookiecutter": {
-    "Introduction": "",  
+    "Introduction": "",
     "type": "api",
     "name": "weather",
-    "description": "Protobuf spec for the weather API.",
+    "description": "Frequenz gRPC API for retrieving weather forecasts.",
     "title": "Frequenz Weather API",
     "keywords": "(comma separated: 'frequenz', <type> and <name> are included automatically)",
     "github_org": "frequenz-floss",

.editorconfig

@@ -0,0 +1,26 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+# Set default charset, indent style and trimming of whitespace
+[{.editorconfig,CODEOWNERS,LICENSE,*.{in,json,md,proto,py,pyi,toml,yaml,yml}}]
+charset = utf-8
+indent_style = space
+trim_trailing_whitespace = true
+
+# 4 space indentation
+[*.{py,pyi}]
+indent_size = 4
+
+# 2 space indentation
+[{.editorconfig,CODEOWNERS,LICENSE,*.{in,json,proto,toml,yaml,yml}}]
+indent_size = 2
+
+# No indentation size specified for *.md because different blocks have
+# different indentation rules

.github/ISSUE_TEMPLATE/config.yml

@@ -4,5 +4,5 @@
 blank_issues_enabled: true
 contact_links:
   - name: Ask a question ❓
-    url: https://github.com/frequenz-io/api-weather-spec/discussions/categories/support
+    url: https://github.com/frequenz-floss/frequenz-api-weather/discussions/new?category=support
     about: Use this if you are not sure how to do something, have installation problems, etc.

.github/dependabot.yml

@@ -3,7 +3,7 @@ updates:
   - package-ecosystem: "pip"
     directory: "/"
     schedule:
-      interval: "daily"
+      interval: "weekly"
       time: "07:00"
     labels:
       - "part:tooling"
@@ -13,11 +13,28 @@ updates:
     versioning-strategy: auto
     # Allow up to 10 open pull requests for updates to dependency versions
     open-pull-requests-limit: 10
+    # We group production and development ("optional" in the context of
+    # pyproject.toml) dependency updates when they are patch and minor updates,
+    # so we end up with less PRs being generated.
+    # Major updates are still managed, but they'll create one PR per
+    # dependency, as major updates are expected to be breaking, it is better to
+    # manage them individually.
+    groups:
+      required:
+        dependency-type: "production"
+        update-types:
+          - "minor"
+          - "patch"
+      optional:
+        dependency-type: "development"
+        update-types:
+          - "minor"
+          - "patch"
 
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
-      interval: "daily"
+      interval: "weekly"
       time: "06:00"
     labels:
       - "part:tooling"
@@ -34,10 +51,8 @@ updates:
     # + `allow` one doesn't seem to work.
     ignore:
       - dependency-name: "submodules/frequenz-api-common"
-    # The google api common repo changes very seldom, so there is no need to
-    # check very often.
     schedule:
-      interval: "monthly"
+      interval: "weekly"
       time: "06:00"
     labels:
       - "part:tooling"

.github/labeler.yml

@@ -33,13 +33,16 @@
   - LICENSE
 
 "part:tests":
+  - "**/conftest.py"
   - "pytests/**"
 
 "part:tooling":
   - "**/*.ini"
   - "**/*.toml"
   - "**/*.yaml"
   - "**/*.yml"
+  - "**/conftest.py"
+  - ".editorconfig"
   - ".git*"
   - ".git*/**"
   - "docs/*.py"

.github/workflows/ci.yaml

@@ -35,7 +35,7 @@ jobs:
 
       - name: Run protolint
         # Only use hashes here, as we are passing the github token, we want to
-        # make sure updates are done conciously to avoid security issues if the
+        # make sure updates are done consciously to avoid security issues if the
         # action repo gets hacked
         uses: yoheimuta/action-protolint@e94cc01b1ad085ed9427098442f66f2519c723eb # v1.0.0
         with:
@@ -55,9 +55,17 @@ jobs:
           - ubuntu-20.04
         python:
           - "3.11"
+        nox-session:
+          # To speed things up a bit we use the special ci_checks_max session
+          # that uses the same venv to run multiple linting sessions
+          - "ci_checks_max"
+          - "pytest_min"
     runs-on: ${{ matrix.os }}
 
     steps:
+      - name: Print environment (debug)
+        run: env
+
       - name: Fetch sources
         uses: actions/checkout@v3
         with:
@@ -73,11 +81,25 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           python -m pip install -e .[dev-noxfile]
+          pip freeze
+
+      - name: Create nox venv
+        env:
+          NOX_SESSION: ${{ matrix.nox-session }}
+        run: nox --install-only -e "$NOX_SESSION"
+
+      - name: Print pip freeze for nox venv (debug)
+        env:
+          NOX_SESSION: ${{ matrix.nox-session }}
+        run: |
+          . ".nox/$NOX_SESSION/bin/activate"
+          pip freeze
+          deactivate
 
       - name: Run nox
-        # To speed things up a bit we use the special ci_checks_max session
-        # that uses the same venv to run multiple linting sessions
-        run: nox -e ci_checks_max pytest_min
+        env:
+          NOX_SESSION: ${{ matrix.nox-session }}
+        run: nox -R -e "$NOX_SESSION"
         timeout-minutes: 10
 
   build:
@@ -99,6 +121,7 @@ jobs:
         run: |
           python -m pip install -U pip
           python -m pip install -U build
+          pip freeze
 
       - name: Build the source and binary distribution
         run: python -m build
@@ -133,6 +156,7 @@ jobs:
         run: |
           python -m pip install -U pip
           python -m pip install .[dev-mkdocs]
+          pip freeze
 
       - name: Generate the documentation
         env:
@@ -196,6 +220,8 @@ jobs:
       - name: Fetch sources
         if: steps.mike-metadata.outputs.version
         uses: actions/checkout@v3
+        with:
+          submodules: true
 
       - name: Setup Git user and e-mail
         if: steps.mike-metadata.outputs.version
@@ -213,6 +239,7 @@ jobs:
         run: |
           python -m pip install -U pip
           python -m pip install .[dev-mkdocs]
+          pip freeze
 
       - name: Fetch the gh-pages branch
         if: steps.mike-metadata.outputs.version

.github/workflows/labeler.yml

@@ -18,7 +18,7 @@ jobs:
         # only use hashes to pick the action to execute (instead of tags or branches).
         # For more details read:
         # https://securitylab.github.com/research/github-actions-preventing-pwn-requests/
-        uses: actions/labeler@0776a679364a9a16110aac8d0f40f5e11009e327  # 4.0.4
+        uses: actions/labeler@ac9175f8a1f3625fd0d4fb234536d26811351594  # 4.3.0
         with:
           repo-token: "${{ secrets.GITHUB_TOKEN }}"
           dot: true

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

@@ -0,0 +1,29 @@
+name: Release Notes Check
+
+on:
+  merge_group:
+  pull_request:
+    types:
+      # On by default if you specify no types.
+      - "opened"
+      - "reopened"
+      - "synchronize"
+      # For `skip-label` only.
+      - "labeled"
+      - "unlabeled"
+
+
+jobs:
+  check-release-notes:
+    name: Check release notes are updated
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check for a release notes update
+        if: github.event_name == 'pull_request'
+        uses: brettcannon/check-for-changed-files@4170644959a21843b31f1181f2a1761d65ef4791 # v1.2.0
+        with:
+          # token: ${{ secrets.github_token }}
+          file-pattern: "RELEASE_NOTES.md"
+          prereq-pattern: "{proto,py}/**"
+          skip-label: "cmd:skip-release-notes"
+          failure-message: "Missing a release notes update. Please add one or apply the ${skip-label} label to the pull request"

.gitmodules

@@ -1,12 +1,6 @@
-[submodule "api-common-protos"]
+[submodule "submodules/api-common-protos"]
 	path = submodules/api-common-protos
 	url = https://github.com/googleapis/api-common-protos.git
 [submodule "submodules/frequenz-api-common"]
 	path = submodules/frequenz-api-common
 	url = https://github.com/frequenz-floss/frequenz-api-common.git
-[submodule "submodules/api-common-protos"]
-	path = submodules/api-common-protos
-	url = https://github.com/googleapis/api-common-protos.git
-[submodule "submodules/submodules/api-common-protos"]
-	path = submodules/submodules/api-common-protos
-	url = https://github.com/googleapis/api-common-protos.git

MANIFEST.in

@@ -1,2 +1,15 @@
-recursive-include submodules/api-common-protos/google *.proto
-recursive-include submodules/frequenz-api-common/proto *.proto
+exclude .cookiecutter-replay.json
+exclude .editorconfig
+exclude .gitignore
+exclude .gitmodules
+exclude CODEOWNERS
+exclude CONTRIBUTING.md
+exclude mkdocs.yml
+exclude noxfile.py
+exclude src/conftest.py
+recursive-exclude .github *
+recursive-exclude benchmarks *
+recursive-exclude docs *
+recursive-exclude pytests *
+recursive-include py *.pyi
+recursive-include submodules *.proto

mkdocs.yml

@@ -24,6 +24,7 @@ theme:
   features:
     - content.code.annotate
     - content.code.copy
+    - navigation.indexes
     - navigation.instant
     - navigation.tabs
     - navigation.top
@@ -104,10 +105,10 @@ plugins:
             show_source: true
           import:
             - https://docs.python.org/3/objects.inv
+            - https://frequenz-floss.github.io/frequenz-api-common/v0.3/objects.inv
             - https://grpc.github.io/grpc/python/objects.inv
             - https://typing-extensions.readthedocs.io/en/stable/objects.inv
   - search
-  - section-index
 
 # Preview controls
 watch:

py/conftest.py

@@ -0,0 +1,13 @@
+# License: MIT
+# Copyright © 2023 Frequenz Energy-as-a-Service GmbH
+
+"""Validate docstring code examples.
+
+Code examples are often wrapped in triple backticks (```) within docstrings.
+This plugin extracts these code examples and validates them using pylint.
+"""
+
+from frequenz.repo.config.pytest import examples
+from sybil import Sybil
+
+pytest_collect_file = Sybil(**examples.get_sybil_arguments()).pytest()