Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prepare for v0.8.0 release #204

Merged
merged 1 commit into from
Dec 20, 2023
Merged

Prepare for v0.8.0 release #204

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 23 additions & 6 deletions RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,33 @@

## Summary

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

## Upgrading

<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->

### Cookiecutter template

<!-- Here upgrade steps for cookiecutter specifically -->
You can follow these steps to upgrade without regenerating the whole project, if you kept the default project structure and configuration:

* Update the `frequenz-repo-config` dependencies in `pyproject.toml` to 0.8.0.

* Run in the root directory of your project:

```sh
sed -i '/custom_templates: templates/d' mkdocs.yml
sed -i '/ "too-few-public-methods",/a \ "too-many-return-statements",' pyproject.toml
find -type f -exec sed -i 's/Freqenz/Frequenz/g' {} +
cat <<EOF >> .gitignore

# Auto-generated python files from the protocol buffer compiler
py/**/*_pb2.py
py/**/*_pb2.pyi
py/**/*_pb2_grpc.py
py/**/*_pb2_grpc.pyi
EOF
```

* 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.

## New Features

Expand All @@ -24,10 +42,9 @@

## Bug Fixes

<!-- Here goes notable bug fixes that are worth a special mention or explanation -->

### Cookiecutter template

* Fix typo: `Freqenz` -> `Frequenz`
* Fix `mkdocs.yml` to avoid specifying `custom_templates` for `mkdocstrings` as it is unused and is checked for existence in newer versions.
* Fix paths that are not translated properly from the python package name (#198)
* Fix outdated `frequenz-repo-config` dependency
8 changes: 4 additions & 4 deletions cookiecutter/{{cookiecutter.github_repo_name}}/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
requires = [
"setuptools == 68.1.0",
"setuptools_scm[toml] == 7.1.0",
"frequenz-repo-config[{{cookiecutter.type}}] == 0.7.0",
"frequenz-repo-config[{{cookiecutter.type}}] == 0.8.0",
]
build-backend = "setuptools.build_meta"

Expand Down Expand Up @@ -77,7 +77,7 @@ dev-mkdocs = [
"mkdocs-macros-plugin == 1.0.4",
"mkdocs-material == 9.3.1",
"mkdocstrings[python] == 0.23.0",
"frequenz-repo-config[{{cookiecutter.type}}] == 0.7.0",
"frequenz-repo-config[{{cookiecutter.type}}] == 0.8.0",
]
dev-mypy = [
"mypy == 1.5.1",
Expand All @@ -90,7 +90,7 @@ dev-mypy = [
]
dev-noxfile = [
"nox == 2023.4.22",
"frequenz-repo-config[{{cookiecutter.type}}] == 0.7.0",
"frequenz-repo-config[{{cookiecutter.type}}] == 0.8.0",
]
dev-pylint = [
"pylint == 3.0.2",
Expand All @@ -99,7 +99,7 @@ dev-pylint = [
]
dev-pytest = [
"pytest == 7.4.2",
"frequenz-repo-config[extra-lint-examples] == 0.7.0",
"frequenz-repo-config[extra-lint-examples] == 0.8.0",
{%- if cookiecutter.type != "api" %}
"pytest-mock == 3.11.1",
"pytest-asyncio == 0.21.1",
Expand Down
8 changes: 4 additions & 4 deletions ..._golden/integration/test_cookiecutter_generation/actor/frequenz-actor-test/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
requires = [
"setuptools == 68.1.0",
"setuptools_scm[toml] == 7.1.0",
"frequenz-repo-config[actor] == 0.7.0",
"frequenz-repo-config[actor] == 0.8.0",
]
build-backend = "setuptools.build_meta"

Expand Down Expand Up @@ -59,7 +59,7 @@ dev-mkdocs = [
"mkdocs-macros-plugin == 1.0.4",
"mkdocs-material == 9.3.1",
"mkdocstrings[python] == 0.23.0",
"frequenz-repo-config[actor] == 0.7.0",
"frequenz-repo-config[actor] == 0.8.0",
]
dev-mypy = [
"mypy == 1.5.1",
Expand All @@ -69,7 +69,7 @@ dev-mypy = [
]
dev-noxfile = [
"nox == 2023.4.22",
"frequenz-repo-config[actor] == 0.7.0",
"frequenz-repo-config[actor] == 0.8.0",
]
dev-pylint = [
"pylint == 3.0.2",
Expand All @@ -78,7 +78,7 @@ dev-pylint = [
]
dev-pytest = [
"pytest == 7.4.2",
"frequenz-repo-config[extra-lint-examples] == 0.7.0",
"frequenz-repo-config[extra-lint-examples] == 0.8.0",
"pytest-mock == 3.11.1",
"pytest-asyncio == 0.21.1",
"async-solipsism == 0.5",
Expand Down
8 changes: 4 additions & 4 deletions tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
requires = [
"setuptools == 68.1.0",
"setuptools_scm[toml] == 7.1.0",
"frequenz-repo-config[api] == 0.7.0",
"frequenz-repo-config[api] == 0.8.0",
]
build-backend = "setuptools.build_meta"

Expand Down Expand Up @@ -57,7 +57,7 @@ dev-mkdocs = [
"mkdocs-macros-plugin == 1.0.4",
"mkdocs-material == 9.3.1",
"mkdocstrings[python] == 0.23.0",
"frequenz-repo-config[api] == 0.7.0",
"frequenz-repo-config[api] == 0.8.0",
]
dev-mypy = [
"mypy == 1.5.1",
Expand All @@ -68,7 +68,7 @@ dev-mypy = [
]
dev-noxfile = [
"nox == 2023.4.22",
"frequenz-repo-config[api] == 0.7.0",
"frequenz-repo-config[api] == 0.8.0",
]
dev-pylint = [
"pylint == 3.0.2",
Expand All @@ -77,7 +77,7 @@ dev-pylint = [
]
dev-pytest = [
"pytest == 7.4.2",
"frequenz-repo-config[extra-lint-examples] == 0.7.0",
"frequenz-repo-config[extra-lint-examples] == 0.8.0",
]
dev = [
"frequenz-api-test[dev-mkdocs,dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]",
Expand Down
8 changes: 4 additions & 4 deletions tests_golden/integration/test_cookiecutter_generation/app/frequenz-app-test/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
requires = [
"setuptools == 68.1.0",
"setuptools_scm[toml] == 7.1.0",
"frequenz-repo-config[app] == 0.7.0",
"frequenz-repo-config[app] == 0.8.0",
]
build-backend = "setuptools.build_meta"

Expand Down Expand Up @@ -58,7 +58,7 @@ dev-mkdocs = [
"mkdocs-macros-plugin == 1.0.4",
"mkdocs-material == 9.3.1",
"mkdocstrings[python] == 0.23.0",
"frequenz-repo-config[app] == 0.7.0",
"frequenz-repo-config[app] == 0.8.0",
]
dev-mypy = [
"mypy == 1.5.1",
Expand All @@ -68,7 +68,7 @@ dev-mypy = [
]
dev-noxfile = [
"nox == 2023.4.22",
"frequenz-repo-config[app] == 0.7.0",
"frequenz-repo-config[app] == 0.8.0",
]
dev-pylint = [
"pylint == 3.0.2",
Expand All @@ -77,7 +77,7 @@ dev-pylint = [
]
dev-pytest = [
"pytest == 7.4.2",
"frequenz-repo-config[extra-lint-examples] == 0.7.0",
"frequenz-repo-config[extra-lint-examples] == 0.8.0",
"pytest-mock == 3.11.1",
"pytest-asyncio == 0.21.1",
"async-solipsism == 0.5",
Expand Down
8 changes: 4 additions & 4 deletions ...s_golden/integration/test_cookiecutter_generation/lib/frequenz-test-python/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
requires = [
"setuptools == 68.1.0",
"setuptools_scm[toml] == 7.1.0",
"frequenz-repo-config[lib] == 0.7.0",
"frequenz-repo-config[lib] == 0.8.0",
]
build-backend = "setuptools.build_meta"

Expand Down Expand Up @@ -55,7 +55,7 @@ dev-mkdocs = [
"mkdocs-macros-plugin == 1.0.4",
"mkdocs-material == 9.3.1",
"mkdocstrings[python] == 0.23.0",
"frequenz-repo-config[lib] == 0.7.0",
"frequenz-repo-config[lib] == 0.8.0",
]
dev-mypy = [
"mypy == 1.5.1",
Expand All @@ -65,7 +65,7 @@ dev-mypy = [
]
dev-noxfile = [
"nox == 2023.4.22",
"frequenz-repo-config[lib] == 0.7.0",
"frequenz-repo-config[lib] == 0.8.0",
]
dev-pylint = [
"pylint == 3.0.2",
Expand All @@ -74,7 +74,7 @@ dev-pylint = [
]
dev-pytest = [
"pytest == 7.4.2",
"frequenz-repo-config[extra-lint-examples] == 0.7.0",
"frequenz-repo-config[extra-lint-examples] == 0.8.0",
"pytest-mock == 3.11.1",
"pytest-asyncio == 0.21.1",
"async-solipsism == 0.5",
Expand Down
8 changes: 4 additions & 4 deletions ..._golden/integration/test_cookiecutter_generation/model/frequenz-model-test/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
requires = [
"setuptools == 68.1.0",
"setuptools_scm[toml] == 7.1.0",
"frequenz-repo-config[model] == 0.7.0",
"frequenz-repo-config[model] == 0.8.0",
]
build-backend = "setuptools.build_meta"

Expand Down Expand Up @@ -59,7 +59,7 @@ dev-mkdocs = [
"mkdocs-macros-plugin == 1.0.4",
"mkdocs-material == 9.3.1",
"mkdocstrings[python] == 0.23.0",
"frequenz-repo-config[model] == 0.7.0",
"frequenz-repo-config[model] == 0.8.0",
]
dev-mypy = [
"mypy == 1.5.1",
Expand All @@ -69,7 +69,7 @@ dev-mypy = [
]
dev-noxfile = [
"nox == 2023.4.22",
"frequenz-repo-config[model] == 0.7.0",
"frequenz-repo-config[model] == 0.8.0",
]
dev-pylint = [
"pylint == 3.0.2",
Expand All @@ -78,7 +78,7 @@ dev-pylint = [
]
dev-pytest = [
"pytest == 7.4.2",
"frequenz-repo-config[extra-lint-examples] == 0.7.0",
"frequenz-repo-config[extra-lint-examples] == 0.8.0",
"pytest-mock == 3.11.1",
"pytest-asyncio == 0.21.1",
"async-solipsism == 0.5",
Expand Down