Skip to content

Commit bff4d68

Browse files
committed
Update release notes
Also add some missing release notes for new features and a summary in preparation for the release. Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 78cb48b commit bff4d68

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

RELEASE_NOTES.md

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

33
## Summary
44

5-
<!-- Here goes a general summary of what this release is about -->
5+
This release focuses on improving the documentation generation and the CI. In particular it brings a new versioning scheme for the documentation that supports multiple development branches and exposes pre-releases.
66

77
## Upgrading
88

9-
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
10-
119
### Cookiecutter template
1210

11+
- The recommended `cookiecutter` version was bumped to 2.4.0 to avoid some buggy old versions.
12+
1313
- `mkdocs`
1414

1515
- The script `docs/mkdocstrings_autoapi.py` was moved to `docs/_scripts/mkdocstrings.py`.
@@ -39,7 +39,13 @@
3939

4040
## New Features
4141

42-
<!-- Here goes the main new features and examples or instructions on how to use them -->
42+
- `frequenz_repo_config.version`: New module to get the version information for a repository.
43+
- `frequnz_repo_config.github`: New module to interact with GitHub.
44+
- `frequenz.repo_config.mkdocs.mike`: New module to manage `mike` versions and aliases.
45+
- `frequenz.repo_config.cli`: New package to implement CLI commands.
46+
47+
- `frequenz.repo.config.cli.version.mike.info`: New command to print GitHub Action variables with for the current `mike` version.
48+
- `frequenz.repo.config.cli.version.mike.sort`: New command to sort `mike` versions file (`versions.json`).
4349

4450
### Cookiecutter template
4551

@@ -51,6 +57,8 @@
5157
- Make code annotations numbered. This is useful to hint about the order one should read the annotations.
5258
- 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.
5359
- Updated dependencies.
60+
- The hooking of `mkdocstrings` to `macros` plugins is moved to a separate function to avoid the noise in the `define_env()` function.
61+
- Improve formatting of signatures to show the types.
5462
- We use a new `mike` versioning scheme:
5563
5664
- Versions now have a title with the full tag name for tags and includes the (short) commit SHA for branches so users can know exactly which version they are reading.
@@ -64,9 +72,9 @@
6472
- Add a CI job to *join* all `nox` runs, so only one branch protection rule needs to be used.
6573
- 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.
6674
67-
## Bug Fixes
75+
- Add a section about cross-arch testing to `CONTRIBUTING.md`.
6876
69-
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
77+
## Bug Fixes
7078
7179
### Cookiecutter template
7280

0 commit comments

Comments
 (0)