Skip to content

Commit 711ac38

Browse files
llucaxllucax
authored
Prepare for v0.8.0 release (#204)
Bump the version in the cookiecutter template and update the release notes.
2 parents aedc357 + e602cac commit 711ac38

File tree

7 files changed

+47
-30
lines changed

7 files changed

+47
-30
lines changed

‎RELEASE_NOTES.md

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

33
## Summary
44

5-
<!-- Here goes a general summary of what this release is about -->
5+
This is a minor release with some documentation improvements, new GitHub ruleset and a few bug fixes.
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

13-
<!-- Here upgrade steps for cookiecutter specifically -->
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:
16+
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+
```
30+
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.
1432
1533
## New Features
1634
@@ -24,10 +42,9 @@
2442
2543
## Bug Fixes
2644
27-
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
28-
2945
### Cookiecutter template
3046
3147
* Fix typo: `Freqenz` -> `Frequenz`
3248
* Fix `mkdocs.yml` to avoid specifying `custom_templates` for `mkdocstrings` as it is unused and is checked for existence in newer versions.
3349
* Fix paths that are not translated properly from the python package name (#198)
50+
* Fix outdated `frequenz-repo-config` dependency

‎cookiecutter/{{cookiecutter.github_repo_name}}/pyproject.toml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
requires = [
66
"setuptools == 68.1.0",
77
"setuptools_scm[toml] == 7.1.0",
8-
"frequenz-repo-config[{{cookiecutter.type}}] == 0.7.0",
8+
"frequenz-repo-config[{{cookiecutter.type}}] == 0.8.0",
99
]
1010
build-backend = "setuptools.build_meta"
1111

@@ -77,7 +77,7 @@ dev-mkdocs = [
7777
"mkdocs-macros-plugin == 1.0.4",
7878
"mkdocs-material == 9.3.1",
7979
"mkdocstrings[python] == 0.23.0",
80-
"frequenz-repo-config[{{cookiecutter.type}}] == 0.7.0",
80+
"frequenz-repo-config[{{cookiecutter.type}}] == 0.8.0",
8181
]
8282
dev-mypy = [
8383
"mypy == 1.5.1",
@@ -90,7 +90,7 @@ dev-mypy = [
9090
]
9191
dev-noxfile = [
9292
"nox == 2023.4.22",
93-
"frequenz-repo-config[{{cookiecutter.type}}] == 0.7.0",
93+
"frequenz-repo-config[{{cookiecutter.type}}] == 0.8.0",
9494
]
9595
dev-pylint = [
9696
"pylint == 3.0.2",
@@ -99,7 +99,7 @@ dev-pylint = [
9999
]
100100
dev-pytest = [
101101
"pytest == 7.4.2",
102-
"frequenz-repo-config[extra-lint-examples] == 0.7.0",
102+
"frequenz-repo-config[extra-lint-examples] == 0.8.0",
103103
{%- if cookiecutter.type != "api" %}
104104
"pytest-mock == 3.11.1",
105105
"pytest-asyncio == 0.21.1",

‎tests_golden/integration/test_cookiecutter_generation/actor/frequenz-actor-test/pyproject.toml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
requires = [
66
"setuptools == 68.1.0",
77
"setuptools_scm[toml] == 7.1.0",
8-
"frequenz-repo-config[actor] == 0.7.0",
8+
"frequenz-repo-config[actor] == 0.8.0",
99
]
1010
build-backend = "setuptools.build_meta"
1111

@@ -59,7 +59,7 @@ dev-mkdocs = [
5959
"mkdocs-macros-plugin == 1.0.4",
6060
"mkdocs-material == 9.3.1",
6161
"mkdocstrings[python] == 0.23.0",
62-
"frequenz-repo-config[actor] == 0.7.0",
62+
"frequenz-repo-config[actor] == 0.8.0",
6363
]
6464
dev-mypy = [
6565
"mypy == 1.5.1",
@@ -69,7 +69,7 @@ dev-mypy = [
6969
]
7070
dev-noxfile = [
7171
"nox == 2023.4.22",
72-
"frequenz-repo-config[actor] == 0.7.0",
72+
"frequenz-repo-config[actor] == 0.8.0",
7373
]
7474
dev-pylint = [
7575
"pylint == 3.0.2",
@@ -78,7 +78,7 @@ dev-pylint = [
7878
]
7979
dev-pytest = [
8080
"pytest == 7.4.2",
81-
"frequenz-repo-config[extra-lint-examples] == 0.7.0",
81+
"frequenz-repo-config[extra-lint-examples] == 0.8.0",
8282
"pytest-mock == 3.11.1",
8383
"pytest-asyncio == 0.21.1",
8484
"async-solipsism == 0.5",

‎tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test/pyproject.toml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
requires = [
66
"setuptools == 68.1.0",
77
"setuptools_scm[toml] == 7.1.0",
8-
"frequenz-repo-config[api] == 0.7.0",
8+
"frequenz-repo-config[api] == 0.8.0",
99
]
1010
build-backend = "setuptools.build_meta"
1111

@@ -57,7 +57,7 @@ dev-mkdocs = [
5757
"mkdocs-macros-plugin == 1.0.4",
5858
"mkdocs-material == 9.3.1",
5959
"mkdocstrings[python] == 0.23.0",
60-
"frequenz-repo-config[api] == 0.7.0",
60+
"frequenz-repo-config[api] == 0.8.0",
6161
]
6262
dev-mypy = [
6363
"mypy == 1.5.1",
@@ -68,7 +68,7 @@ dev-mypy = [
6868
]
6969
dev-noxfile = [
7070
"nox == 2023.4.22",
71-
"frequenz-repo-config[api] == 0.7.0",
71+
"frequenz-repo-config[api] == 0.8.0",
7272
]
7373
dev-pylint = [
7474
"pylint == 3.0.2",
@@ -77,7 +77,7 @@ dev-pylint = [
7777
]
7878
dev-pytest = [
7979
"pytest == 7.4.2",
80-
"frequenz-repo-config[extra-lint-examples] == 0.7.0",
80+
"frequenz-repo-config[extra-lint-examples] == 0.8.0",
8181
]
8282
dev = [
8383
"frequenz-api-test[dev-mkdocs,dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]",

‎tests_golden/integration/test_cookiecutter_generation/app/frequenz-app-test/pyproject.toml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
requires = [
66
"setuptools == 68.1.0",
77
"setuptools_scm[toml] == 7.1.0",
8-
"frequenz-repo-config[app] == 0.7.0",
8+
"frequenz-repo-config[app] == 0.8.0",
99
]
1010
build-backend = "setuptools.build_meta"
1111

@@ -58,7 +58,7 @@ dev-mkdocs = [
5858
"mkdocs-macros-plugin == 1.0.4",
5959
"mkdocs-material == 9.3.1",
6060
"mkdocstrings[python] == 0.23.0",
61-
"frequenz-repo-config[app] == 0.7.0",
61+
"frequenz-repo-config[app] == 0.8.0",
6262
]
6363
dev-mypy = [
6464
"mypy == 1.5.1",
@@ -68,7 +68,7 @@ dev-mypy = [
6868
]
6969
dev-noxfile = [
7070
"nox == 2023.4.22",
71-
"frequenz-repo-config[app] == 0.7.0",
71+
"frequenz-repo-config[app] == 0.8.0",
7272
]
7373
dev-pylint = [
7474
"pylint == 3.0.2",
@@ -77,7 +77,7 @@ dev-pylint = [
7777
]
7878
dev-pytest = [
7979
"pytest == 7.4.2",
80-
"frequenz-repo-config[extra-lint-examples] == 0.7.0",
80+
"frequenz-repo-config[extra-lint-examples] == 0.8.0",
8181
"pytest-mock == 3.11.1",
8282
"pytest-asyncio == 0.21.1",
8383
"async-solipsism == 0.5",

‎tests_golden/integration/test_cookiecutter_generation/lib/frequenz-test-python/pyproject.toml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
requires = [
66
"setuptools == 68.1.0",
77
"setuptools_scm[toml] == 7.1.0",
8-
"frequenz-repo-config[lib] == 0.7.0",
8+
"frequenz-repo-config[lib] == 0.8.0",
99
]
1010
build-backend = "setuptools.build_meta"
1111

@@ -55,7 +55,7 @@ dev-mkdocs = [
5555
"mkdocs-macros-plugin == 1.0.4",
5656
"mkdocs-material == 9.3.1",
5757
"mkdocstrings[python] == 0.23.0",
58-
"frequenz-repo-config[lib] == 0.7.0",
58+
"frequenz-repo-config[lib] == 0.8.0",
5959
]
6060
dev-mypy = [
6161
"mypy == 1.5.1",
@@ -65,7 +65,7 @@ dev-mypy = [
6565
]
6666
dev-noxfile = [
6767
"nox == 2023.4.22",
68-
"frequenz-repo-config[lib] == 0.7.0",
68+
"frequenz-repo-config[lib] == 0.8.0",
6969
]
7070
dev-pylint = [
7171
"pylint == 3.0.2",
@@ -74,7 +74,7 @@ dev-pylint = [
7474
]
7575
dev-pytest = [
7676
"pytest == 7.4.2",
77-
"frequenz-repo-config[extra-lint-examples] == 0.7.0",
77+
"frequenz-repo-config[extra-lint-examples] == 0.8.0",
7878
"pytest-mock == 3.11.1",
7979
"pytest-asyncio == 0.21.1",
8080
"async-solipsism == 0.5",

‎tests_golden/integration/test_cookiecutter_generation/model/frequenz-model-test/pyproject.toml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
requires = [
66
"setuptools == 68.1.0",
77
"setuptools_scm[toml] == 7.1.0",
8-
"frequenz-repo-config[model] == 0.7.0",
8+
"frequenz-repo-config[model] == 0.8.0",
99
]
1010
build-backend = "setuptools.build_meta"
1111

@@ -59,7 +59,7 @@ dev-mkdocs = [
5959
"mkdocs-macros-plugin == 1.0.4",
6060
"mkdocs-material == 9.3.1",
6161
"mkdocstrings[python] == 0.23.0",
62-
"frequenz-repo-config[model] == 0.7.0",
62+
"frequenz-repo-config[model] == 0.8.0",
6363
]
6464
dev-mypy = [
6565
"mypy == 1.5.1",
@@ -69,7 +69,7 @@ dev-mypy = [
6969
]
7070
dev-noxfile = [
7171
"nox == 2023.4.22",
72-
"frequenz-repo-config[model] == 0.7.0",
72+
"frequenz-repo-config[model] == 0.8.0",
7373
]
7474
dev-pylint = [
7575
"pylint == 3.0.2",
@@ -78,7 +78,7 @@ dev-pylint = [
7878
]
7979
dev-pytest = [
8080
"pytest == 7.4.2",
81-
"frequenz-repo-config[extra-lint-examples] == 0.7.0",
81+
"frequenz-repo-config[extra-lint-examples] == 0.8.0",
8282
"pytest-mock == 3.11.1",
8383
"pytest-asyncio == 0.21.1",
8484
"async-solipsism == 0.5",

0 commit comments

Comments
 (0)