Skip to content

Commit ce77b23

Browse files
authored
Clear release notes and migration script (#389)
2 parents b698be0 + 68f7578 commit ce77b23

File tree

1 file changed

+35
-1
lines changed

1 file changed

+35
-1
lines changed

RELEASE_NOTES.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,37 @@
1+
# Frequenz Repository Configuration Release Notes
2+
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+
131
## Bug Fixes
232

3-
- Fix `setuptools` dependency range so it is possible to use the latest `setuptools` version.
33+
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
34+
35+
### Cookiecutter template
36+
37+
<!-- Here bug fixes for cookiecutter specifically -->

0 commit comments

Comments
 (0)