Skip to content

Commit f6c99e8

Browse files
authored
Clear release notes (#419)
2 parents 0da3bdb + cb985b6 commit f6c99e8

File tree

1 file changed

+32
-6
lines changed

1 file changed

+32
-6
lines changed

RELEASE_NOTES.md

Lines changed: 32 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,37 @@
11
# Frequenz Repository Configuration Release Notes
22

3+
## Summary
4+
5+
<!-- Here goes a general summary of what this release is about -->
6+
7+
## Upgrading
8+
9+
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
10+
11+
### Cookiecutter template
12+
13+
All upgrading should be done via the migration script or regenerating the templates.
14+
15+
```bash
16+
curl -sSL https://raw.githubusercontent.com/frequenz-floss/frequenz-repo-config-python/v0.12/cookiecutter/migrate.py | python3
17+
```
18+
19+
But you might still need to adapt your code:
20+
21+
<!-- Here upgrade steps for cookiecutter specifically -->
22+
23+
## New Features
24+
25+
<!-- Here goes the main new features and examples or instructions on how to use them -->
26+
27+
### Cookiecutter template
28+
29+
<!-- Here new features for cookiecutter specifically -->
30+
331
## Bug Fixes
432

5-
- Fixed some typos in the docs.
6-
- Fixed wrong comparison for `mike` versions when versions were equal.
7-
- Fixed version regex escaping of `.`. This means that a version like v0x1e1 were accepted as valid semver versions. Now this version is not considered a semver version anymore.
8-
- `setuptools.grpc_tools`: Fix wrong passing of include paths when passed via:
33+
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
34+
35+
### Cookiecutter template
936

10-
* Command-line: Now extra white-spaces and empty strings are removed, before they were passed to `protoc -I`.
11-
* `pyproject.toml`: Now an empty array/list can be passed to override the default paths, before this resulted in an empty string being passed to `protoc -I`.
37+
<!-- Here bug fixes for cookiecutter specifically -->

0 commit comments

Comments
 (0)