|
2 | 2 |
|
3 | 3 | ## Summary |
4 | 4 |
|
5 | | -This is a minor release with some documentation improvements, new GitHub ruleset and a few bug fixes. |
| 5 | +<!-- Here goes a general summary of what this release is about --> |
6 | 6 |
|
7 | 7 | ## Upgrading |
8 | 8 |
|
9 | | -### Cookiecutter template |
10 | | - |
11 | | -You can follow these steps to upgrade without regenerating the whole project, if you kept the default project structure and configuration: |
12 | | - |
13 | | -* Update the `frequenz-repo-config` dependencies in `pyproject.toml` to 0.8.0. |
14 | | - |
15 | | -* Run in the root directory of your project: |
| 9 | +<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with --> |
16 | 10 |
|
17 | | - ```sh |
18 | | - sed -i '/custom_templates: templates/d' mkdocs.yml |
19 | | - sed -i '/ "too-few-public-methods",/a \ "too-many-return-statements",' pyproject.toml |
20 | | - find -type f -exec sed -i 's/Freqenz/Frequenz/g' {} + |
21 | | - cat <<EOF >> .gitignore |
22 | | -
|
23 | | - # Auto-generated python files from the protocol buffer compiler |
24 | | - py/**/*_pb2.py |
25 | | - py/**/*_pb2.pyi |
26 | | - py/**/*_pb2_grpc.py |
27 | | - py/**/*_pb2_grpc.pyi |
28 | | - EOF |
29 | | - ``` |
| 11 | +### Cookiecutter template |
30 | 12 |
|
31 | | -* Optionally go to the GitHub project's settings and replace branch protection rules with the new rulesets. See the new [GitHub configuration guide](https://frequenz-floss.github.io/frequenz-repo-config-python/v0.8/user-guide/start-a-new-project/github-configuration/#branches) for more details. |
| 13 | +<!-- Here upgrade steps for cookiecutter specifically --> |
32 | 14 |
|
33 | 15 | ## New Features |
34 | 16 |
|
35 | | -- New GitHub rulesets are provided with the recommended configuration to protect branches and tags. |
36 | | -- The documentation is restructured into a more organized, easier-to-navigate user guide. |
37 | | -- Documentation on how to configure the GitHub project and PyPI package is now provided. |
| 17 | +<!-- Here goes the main new features and examples or instructions on how to use them --> |
38 | 18 |
|
39 | 19 | ### Cookiecutter template |
40 | 20 |
|
41 | | -- The `pylint` check `too-many-return-statements` is now disabled by default. |
42 | | -- Generated protobuf files are now ignored by Git. |
| 21 | +<!-- Here new features for cookiecutter specifically --> |
43 | 22 |
|
44 | 23 | ## Bug Fixes |
45 | 24 |
|
| 25 | +<!-- Here goes notable bug fixes that are worth a special mention or explanation --> |
| 26 | + |
46 | 27 | ### Cookiecutter template |
47 | 28 |
|
48 | | -* Fix typo: `Freqenz` -> `Frequenz` |
49 | | -* Fix `mkdocs.yml` to avoid specifying `custom_templates` for `mkdocstrings` as it is unused and is checked for existence in newer versions. |
50 | | -* Fix paths that are not translated properly from the python package name (#198) |
51 | | -* Fix outdated `frequenz-repo-config` dependency |
| 29 | +<!-- Here bug fixes for cookiecutter specifically --> |
0 commit comments