Skip to content

Commit 4d1e8e2

Browse files
committed
Prepare release notes for the new release
Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 1a87311 commit 4d1e8e2

File tree

1 file changed

+33
-6
lines changed

1 file changed

+33
-6
lines changed

RELEASE_NOTES.md

Lines changed: 33 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,51 @@
22

33
## Summary
44

5-
<!-- Here goes a general summary of what this release is about -->
5+
This release only ships fixes and improvements for Cookiecutter templates, it is recommended for existing projects to regenerate the templates.
66

77
## Upgrading
88

9-
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
9+
### Cookiecutter templates
10+
11+
* You might want to remove the `_output_dir` from the
12+
`.cookiecutter-replay.json` file, if there is one in your project.
13+
* You will need to manually add `local_extensions.as_identifier` to the `_extensions` key in the `.cookiecutter-replay.json` file before running the replay.
1014

1115
## New Features
1216

1317
### Cookiecutter templates
1418

1519
* Add linting to the CI with `protolint` for API projects.
16-
* Bump SDK version to v0.22.0.
1720
* Capitalize project name in title and expand shortened words.
18-
* Add a few more default keywords.
19-
* Add variable reference documentation.
21+
* Add templates variables reference documentation in the genrated docs and when running Cookiecutter.
22+
* Do some basic templates variables validation.
23+
24+
* `labeler` workflow configuration
25+
26+
* Label `docs/*.py` as tooling.
27+
* Add example on how to exclude files.
28+
29+
* `pyproject.toml`
30+
31+
* Bump SDK version to v0.22.0.
32+
* Disable `pylint`'s `unsubscriptable-object` check.
33+
* Add a few more default keywords.
34+
* Run `isort` in `benchmarks/` too
35+
36+
* `mkdocs`
37+
38+
* Add more cross-reference inventories: `typing-extensions`, `frequenz-sdk`, `frequenz-channels`, `grpc`.
39+
* Add some extra markdown plugins: code annotations, copy button and line numbers, keys representation.
40+
* Be strict when building the docs (any warning will make the generation fail).
2041

2142
## Bug Fixes
2243

23-
### Cookiecutter
44+
### Cookiecutter templates
2445

2546
* Fix hardcoded MIT license headers. Now the user selected license is used instead.
47+
* Properly handle project names with `-` and `_` in them.
48+
49+
* `pyproject.toml`
50+
51+
* Add missing `repo-config` to `dev-mkdocs` dependencies.
52+
* Fix wrong optional dependency name for `dev` dependencies.

0 commit comments

Comments
 (0)