RELEASE_NOTES.md

Frequenz Repository Configuration Release Notes

Summary

Upgrading

Cookiecutter template

• mkdocs

  • The script docs/mkdocstrings_autoapi.py was moved to docs/_scripts/mkdocstrings.py.

  • Note that now code annotations will be numbered. This is useful to hint about the order one should read the annotations.

  • The following files were renamed to keep the documentation directory clean for documentation files:

    • docs/css -> docs/_css
    • docs/overrides -> docs/_overrides
    • logo.png -> docs/_img/logo.png

• CI

  • You can now make your branch protection rule only require the "Test with nox" CI job to pass. All the matrix expansions will merge into it, so there is no need to change branch protection rules if matrix elements are added or removed.
  • Dependabot now will check for updates monthly and on a random day and time.

New Features

Cookiecutter template

• mkdocs

  • New markdown extensions: def_list / task_list and footnotes.
  • New mkdocs-macros extension.
  • Show inherited attributes in the documentation.
  • Make code annotations numbered. This is useful to hint about the order one should read the annotations.
  • Add a navigation footer to show previous and next pages. This is specially useful when reading the documentation in a mobile device since the navigation bar is hidden.
  • Updated dependencies.

• CI

  • Add CI job to test package installation on multiple platforms (amd64 and arm64).
  • Add CI job to run the tests in arm64.
  • Add a CI job to join all nox runs, so only one branch protection rule needs to be used.
  • Dependabot now will check for updates monthly and on a random day and time. This is to avoid all repositories updating at the same time.

Bug Fixes

Cookiecutter template

• mkdocs

  • Fixed mermaid diagrams not rendering in the documentation.
  • mypy ignores for cookiecutter have been removed. They should have never be there as generated projects don't use cookiecutter.
  • mypy overrides now are applied to API projects too.