Skip to content

Commit d01b08e

Browse files
committed
Update release notes
Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 0c3bc44 commit d01b08e

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

RELEASE_NOTES.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Summary
44

5-
<!-- Here goes a general summary of what this release is about -->
5+
This release introduces a new MkDocs macros *pluglet* system that simplifies documentation setup and provides enhanced functionality for version information and code annotations. It also includes changes to how pytest warnings are handled in templates.
66

77
## Upgrading
88

@@ -15,22 +15,28 @@
1515

1616
### Cookiecutter template
1717

18-
All upgrading should be done via the migration script or regenerating the templates. But you might still need to adapt your code:
18+
All upgrading should be done via the migration script or regenerating the templates.
19+
20+
```bash
21+
curl -sSL https://raw.githubusercontent.com/frequenz-floss/frequenz-repo-config-python/v0.12/cookiecutter/migrate.py | python3
22+
```
23+
24+
But you might still need to adapt your code:
1925

2026
- `pytest` now uses `-Werror` by default (but still treat deprecations as normal warnings), so if your tests run with warnings, they will now be turned to errors, and you'll need to fix them.
2127

28+
- Projects using `docs/_scripts/macros.py` with customized scripts can use the new provided utility functions. See the [`mkdocstrings_macros` documentation](https://frequenz-floss.github.io/frequenz-repo-config-python/v0.12/reference/frequenz/repo/config/mkdocs/mkdocstrings_macros/) for the new features and setup.
29+
2230
## New Features
2331

24-
<!-- Here goes the main new features and examples or instructions on how to use them -->
32+
- Two new modules were introduced to facilitate the configuration of `macros` for use within docstrings via `mkdocstrings`: [`mkdocstrings_macros`](https://frequenz-floss.github.io/frequenz-repo-config-python/v0.12/reference/frequenz/repo/config/mkdocs/mkdocstrings_macros/) and [`annotations`](https://frequenz-floss.github.io/frequenz-repo-config-python/v0.12/reference/frequenz/repo/config/mkdocs/annotations/).
2533

2634
### Cookiecutter template
2735

2836
- `pytest` now uses `-Werror -Wdefault::DeprecationWarning -Wdefault::PendingDeprecationWarning` by default. Deprecations are still treated as warnings, as when testing with the `pytest_min` session is normal to get deprecation warnings as we are using old versions of dependencies.
2937

3038
## Bug Fixes
3139

32-
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
33-
3440
### Cookiecutter template
3541

3642
- Fixed a compatibility issue in the macros doc script with `mkdocsstrings` 0.28.

0 commit comments

Comments
 (0)