Skip to content

Commit 9eb9725

Browse files
committed
Clear release notes and migration script
Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 3fc1a3b commit 9eb9725

File tree

1 file changed

+31
-1
lines changed

1 file changed

+31
-1
lines changed

RELEASE_NOTES.md

+31-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +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

33+
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
34+
535
### Cookiecutter template
636

7-
- Fixed an outdated link to instructions on how to continue when the cookiecutter template generation finishes.
37+
<!-- Here bug fixes for cookiecutter specifically -->

0 commit comments

Comments
 (0)