Add release notes

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>

.github/workflows/ci.yaml

@@ -35,6 +35,10 @@ jobs:
     runs-on: ${{ matrix.os }}
 
     steps:
+      - name: Print environment
+        if: env.RUNNER_DEBUG == '1'
+        run: env
+
       - name: Fetch sources
         uses: actions/checkout@v3
         with:

RELEASE_NOTES.md

@@ -6,19 +6,27 @@
 
 ## Upgrading
 
-<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
+- `flake8` basic checks are enabled now. Most are already covered by `pylint`, but there are a few differences, so you might need to fix your code if `flake8` find some issues.
+
+- `darglint` was replaced by `pydoclint`, `pydoclint` can find a few more issues than `darglint`, so your code might need adjusting.
+
+- `darglint` is not used anymore, but if it is installed, it will make `flake8` run extremely slowly anyways, so it is extremely recommended to uninstall it (`pip uninstall darglint`) and rebuild you `nox` *venvs* if you use `-R`.
+
+- If you are upgrading without regenerating the cookiecutter templates, you'll need to adjust the dependencies accordingly.
 
 ### Cookiecutter template
 
-<!-- Here upgrade steps for cookiecutter specifically -->
+- See the general upgrading section.
 
 ## New Features
 
-<!-- Here goes the main new features and examples or instructions on how to use them -->
+- `flake8` is now used to check the files.
+
+- `darlint` was replaced by `pydoclint`, which is way faster and detect more issues.
 
 ### Cookiecutter template
 
-<!-- Here new features for cookiecutter specifically -->
+- See the general new features section.
 
 ## Bug Fixes
 

cookiecutter/{{cookiecutter.github_repo_name}}/pyproject.toml

@@ -36,9 +36,9 @@ requires-python = ">= 3.11, < 4"
 {%- if cookiecutter.type in ("app", "actor", "model") %}
 dependencies = [
   "typing-extensions == 4.5.0",
-  # Make sure to update the mkdocs.yml file when
-  # changing the version
-  # (plugins.mkdocstrings.handlers.python.import)
+  # Make sure to update the version for cross-referencing also in the
+  # mkdocs.yml file when changing the version here (look for the config key
+  # plugins.mkdocstrings.handlers.python.import)
   "frequenz-sdk == 0.24.0",
 ]
 {%- elif cookiecutter.type == "api" %}

tests_golden/integration/test_cookiecutter_generation/actor/frequenz-actor-test/pyproject.toml

@@ -29,9 +29,9 @@ requires-python = ">= 3.11, < 4"
 # TODO(cookiecutter): Remove and add more dependencies if appropriate
 dependencies = [
   "typing-extensions == 4.5.0",
-  # Make sure to update the mkdocs.yml file when
-  # changing the version
-  # (plugins.mkdocstrings.handlers.python.import)
+  # Make sure to update the version for cross-referencing also in the
+  # mkdocs.yml file when changing the version here (look for the config key
+  # plugins.mkdocstrings.handlers.python.import)
   "frequenz-sdk == 0.24.0",
 ]
 dynamic = ["version"]

tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test/pyproject.toml

@@ -46,7 +46,6 @@ dev-flake8 = [
   "flake8-pyproject == 1.2.3",  # For reading the flake8 config from pyproject.toml
   "pydoclint == 0.2.4",
   "pydocstyle == 6.3.0",
-  "tomli == 2.0.1",      # Needed by pydocstyle to read pyproject.toml
 ]
 dev-formatting = ["black == 23.7.0", "isort == 5.12.0"]
 dev-mkdocs = [

tests_golden/integration/test_cookiecutter_generation/app/frequenz-app-test/pyproject.toml

@@ -28,9 +28,9 @@ requires-python = ">= 3.11, < 4"
 # TODO(cookiecutter): Remove and add more dependencies if appropriate
 dependencies = [
   "typing-extensions == 4.5.0",
-  # Make sure to update the mkdocs.yml file when
-  # changing the version
-  # (plugins.mkdocstrings.handlers.python.import)
+  # Make sure to update the version for cross-referencing also in the
+  # mkdocs.yml file when changing the version here (look for the config key
+  # plugins.mkdocstrings.handlers.python.import)
   "frequenz-sdk == 0.24.0",
 ]
 dynamic = ["version"]

tests_golden/integration/test_cookiecutter_generation/model/frequenz-model-test/pyproject.toml

@@ -29,9 +29,9 @@ requires-python = ">= 3.11, < 4"
 # TODO(cookiecutter): Remove and add more dependencies if appropriate
 dependencies = [
   "typing-extensions == 4.5.0",
-  # Make sure to update the mkdocs.yml file when
-  # changing the version
-  # (plugins.mkdocstrings.handlers.python.import)
+  # Make sure to update the version for cross-referencing also in the
+  # mkdocs.yml file when changing the version here (look for the config key
+  # plugins.mkdocstrings.handlers.python.import)
   "frequenz-sdk == 0.24.0",
 ]
 dynamic = ["version"]