Skip to content

v0.4.0

Choose a tag to compare

View all tags
@github-actions github-actions released this 12 Jul 16:05
v0.4.0
This tag was signed with the committer’s verified signature. The key has expired.
llucax Leandro Lucarella
GPG key ID: F75C5E5CA8EB7FE7
Expired
Verified
Learn about vigilant mode.
3664a9b
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode.

Frequenz Repository Configuration Release Notes

Summary

This release only ships fixes and improvements for Cookiecutter templates, it is recommended for existing projects to regenerate the templates.

Upgrading

Cookiecutter templates

  • You might want to remove the _output_dir from the
    .cookiecutter-replay.json file, if there is one in your project.
  • You will need to manually add local_extensions.as_identifier to the _extensions key in the .cookiecutter-replay.json file before running the replay.

New Features

Cookiecutter templates

  • Add linting to the CI with protolint for API projects.

  • Capitalize project name in title and expand shortened words.

  • Add templates variables reference documentation in the genrated docs and when running Cookiecutter.

  • Do some basic templates variables validation.

  • labeler workflow configuration

    • Label docs/*.py as tooling.
    • Add example on how to exclude files.

  • pyproject.toml

    • Bump SDK version to v0.22.0.
    • Disable pylint's unsubscriptable-object check.
    • Add a few more default keywords.
    • Run isort in benchmarks/ too

  • mkdocs

    • Add more cross-reference inventories: typing-extensions, frequenz-sdk, frequenz-channels, grpc.
    • Add some extra markdown plugins: code annotations, copy button and line numbers, keys representation.
    • Be strict when building the docs (any warning will make the generation fail).

Bug Fixes

Cookiecutter templates

  • Fix hardcoded MIT license headers. Now the user selected license is used instead.

  • Properly handle project names with - and _ in them.

  • pyproject.toml

    • Add missing repo-config to dev-mkdocs dependencies.
    • Fix wrong optional dependency name for dev dependencies.

What's Changed

  • Update templates to v0.3.0 by @llucax in #73
  • Fix replay file processing by @llucax in #74
  • Fix a few minor bugs by @llucax in #75
  • Improve cookiecutter mkdocs configuration by @llucax in #77
  • Minor fixes and improvements by @llucax in #81
  • Add linting to the CI with protolint for API projects by @llucax in #84
  • cookiecutter: Update SDK dependency to v0.22.0 by @llucax in #88
  • Capitalize project name in title by @llucax in #89
  • Add example on how to exclude files in the labeler workflow by @llucax in #92
  • Add a few more default keywords by @llucax in #90
  • Fix license headers by @llucax in #91
  • Add template variables docs and warning about cookiecutter command by @llucax in #94
  • Add golden tests for generated files by @llucax in #87
  • Validate template variables and improve defaults by @llucax in #95
  • Prepare v0.4.0 release by @llucax in #96

Full Changelog: v0.3.0...v0.4.0

Contributors

llucax
Assets 4
Loading