Skip to content

Commit

Permalink
Prepare for the v0.10.0 release (#290)
Browse files Browse the repository at this point in the history
- **Prepare the release notes for v0.10.0 release**
- **Update version in the template pyproject.toml**
  • Loading branch information
llucax authored Jul 10, 2024
2 parents 2ac253a + 297b184 commit 6aa6bc0
Show file tree
Hide file tree
Showing 7 changed files with 25 additions and 31 deletions.
8 changes: 1 addition & 7 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,10 @@

## Summary


This release includes quite a few enhancements and bug fixes for the cookiecutter template, but most importantly a new script for migrating to new templates, generating the templates is no longer needed for upgrading.

## Upgrading

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

### Cookiecutter template

- A new script for migrating to new templates (instead of regenerating all files) is provided. It can't handle the upgrade 100% automatically, but should make the migration process much easier and less error prone.
Expand All @@ -28,10 +26,6 @@

- A new GitHub ruleset is provided to configure the merge queue, so branch protection rules are not needed anymore.

### Cookiecutter template

<!-- Here new features for cookiecutter specifically -->

## Enhancements

- The generated docs now show the symbol type in the table of contents.
Expand Down
8 changes: 4 additions & 4 deletions cookiecutter/{{cookiecutter.github_repo_name}}/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
requires = [
"setuptools == 70.1.1",
"setuptools_scm[toml] == 8.1.0",
"frequenz-repo-config[{{cookiecutter.type}}] == 0.9.2",
"frequenz-repo-config[{{cookiecutter.type}}] == 0.10.0",
]
build-backend = "setuptools.build_meta"

Expand Down Expand Up @@ -78,7 +78,7 @@ dev-mkdocs = [
"mkdocs-material == 9.5.27",
"mkdocstrings[python] == 0.25.1",
"mkdocstrings-python == 1.10.5",
"frequenz-repo-config[{{cookiecutter.type}}] == 0.9.2",
"frequenz-repo-config[{{cookiecutter.type}}] == 0.10.0",
]
dev-mypy = [
"mypy == 1.9.0",
Expand All @@ -91,7 +91,7 @@ dev-mypy = [
]
dev-noxfile = [
"nox == 2024.4.15",
"frequenz-repo-config[{{cookiecutter.type}}] == 0.9.2",
"frequenz-repo-config[{{cookiecutter.type}}] == 0.10.0",
]
dev-pylint = [
# dev-pytest already defines a dependency to pylint because of the examples
Expand All @@ -101,7 +101,7 @@ dev-pylint = [
dev-pytest = [
"pytest == 8.2.2",
"pylint == 3.2.5", # We need this to check for the examples
"frequenz-repo-config[extra-lint-examples] == 0.9.2",
"frequenz-repo-config[extra-lint-examples] == 0.10.0",
{%- if cookiecutter.type != "api" %}
"pytest-mock == 3.14.0",
"pytest-asyncio == 0.23.7",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
requires = [
"setuptools == 70.1.1",
"setuptools_scm[toml] == 8.1.0",
"frequenz-repo-config[actor] == 0.9.2",
"frequenz-repo-config[actor] == 0.10.0",
]
build-backend = "setuptools.build_meta"

Expand Down Expand Up @@ -60,7 +60,7 @@ dev-mkdocs = [
"mkdocs-material == 9.5.27",
"mkdocstrings[python] == 0.25.1",
"mkdocstrings-python == 1.10.5",
"frequenz-repo-config[actor] == 0.9.2",
"frequenz-repo-config[actor] == 0.10.0",
]
dev-mypy = [
"mypy == 1.9.0",
Expand All @@ -70,7 +70,7 @@ dev-mypy = [
]
dev-noxfile = [
"nox == 2024.4.15",
"frequenz-repo-config[actor] == 0.9.2",
"frequenz-repo-config[actor] == 0.10.0",
]
dev-pylint = [
# dev-pytest already defines a dependency to pylint because of the examples
Expand All @@ -80,7 +80,7 @@ dev-pylint = [
dev-pytest = [
"pytest == 8.2.2",
"pylint == 3.2.5", # We need this to check for the examples
"frequenz-repo-config[extra-lint-examples] == 0.9.2",
"frequenz-repo-config[extra-lint-examples] == 0.10.0",
"pytest-mock == 3.14.0",
"pytest-asyncio == 0.23.7",
"async-solipsism == 0.6",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
requires = [
"setuptools == 70.1.1",
"setuptools_scm[toml] == 8.1.0",
"frequenz-repo-config[api] == 0.9.2",
"frequenz-repo-config[api] == 0.10.0",
]
build-backend = "setuptools.build_meta"

Expand Down Expand Up @@ -58,7 +58,7 @@ dev-mkdocs = [
"mkdocs-material == 9.5.27",
"mkdocstrings[python] == 0.25.1",
"mkdocstrings-python == 1.10.5",
"frequenz-repo-config[api] == 0.9.2",
"frequenz-repo-config[api] == 0.10.0",
]
dev-mypy = [
"mypy == 1.9.0",
Expand All @@ -69,7 +69,7 @@ dev-mypy = [
]
dev-noxfile = [
"nox == 2024.4.15",
"frequenz-repo-config[api] == 0.9.2",
"frequenz-repo-config[api] == 0.10.0",
]
dev-pylint = [
# dev-pytest already defines a dependency to pylint because of the examples
Expand All @@ -79,7 +79,7 @@ dev-pylint = [
dev-pytest = [
"pytest == 8.2.2",
"pylint == 3.2.5", # We need this to check for the examples
"frequenz-repo-config[extra-lint-examples] == 0.9.2",
"frequenz-repo-config[extra-lint-examples] == 0.10.0",
]
dev = [
"frequenz-api-test[dev-mkdocs,dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
requires = [
"setuptools == 70.1.1",
"setuptools_scm[toml] == 8.1.0",
"frequenz-repo-config[app] == 0.9.2",
"frequenz-repo-config[app] == 0.10.0",
]
build-backend = "setuptools.build_meta"

Expand Down Expand Up @@ -59,7 +59,7 @@ dev-mkdocs = [
"mkdocs-material == 9.5.27",
"mkdocstrings[python] == 0.25.1",
"mkdocstrings-python == 1.10.5",
"frequenz-repo-config[app] == 0.9.2",
"frequenz-repo-config[app] == 0.10.0",
]
dev-mypy = [
"mypy == 1.9.0",
Expand All @@ -69,7 +69,7 @@ dev-mypy = [
]
dev-noxfile = [
"nox == 2024.4.15",
"frequenz-repo-config[app] == 0.9.2",
"frequenz-repo-config[app] == 0.10.0",
]
dev-pylint = [
# dev-pytest already defines a dependency to pylint because of the examples
Expand All @@ -79,7 +79,7 @@ dev-pylint = [
dev-pytest = [
"pytest == 8.2.2",
"pylint == 3.2.5", # We need this to check for the examples
"frequenz-repo-config[extra-lint-examples] == 0.9.2",
"frequenz-repo-config[extra-lint-examples] == 0.10.0",
"pytest-mock == 3.14.0",
"pytest-asyncio == 0.23.7",
"async-solipsism == 0.6",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
requires = [
"setuptools == 70.1.1",
"setuptools_scm[toml] == 8.1.0",
"frequenz-repo-config[lib] == 0.9.2",
"frequenz-repo-config[lib] == 0.10.0",
]
build-backend = "setuptools.build_meta"

Expand Down Expand Up @@ -56,7 +56,7 @@ dev-mkdocs = [
"mkdocs-material == 9.5.27",
"mkdocstrings[python] == 0.25.1",
"mkdocstrings-python == 1.10.5",
"frequenz-repo-config[lib] == 0.9.2",
"frequenz-repo-config[lib] == 0.10.0",
]
dev-mypy = [
"mypy == 1.9.0",
Expand All @@ -66,7 +66,7 @@ dev-mypy = [
]
dev-noxfile = [
"nox == 2024.4.15",
"frequenz-repo-config[lib] == 0.9.2",
"frequenz-repo-config[lib] == 0.10.0",
]
dev-pylint = [
# dev-pytest already defines a dependency to pylint because of the examples
Expand All @@ -76,7 +76,7 @@ dev-pylint = [
dev-pytest = [
"pytest == 8.2.2",
"pylint == 3.2.5", # We need this to check for the examples
"frequenz-repo-config[extra-lint-examples] == 0.9.2",
"frequenz-repo-config[extra-lint-examples] == 0.10.0",
"pytest-mock == 3.14.0",
"pytest-asyncio == 0.23.7",
"async-solipsism == 0.6",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
requires = [
"setuptools == 70.1.1",
"setuptools_scm[toml] == 8.1.0",
"frequenz-repo-config[model] == 0.9.2",
"frequenz-repo-config[model] == 0.10.0",
]
build-backend = "setuptools.build_meta"

Expand Down Expand Up @@ -60,7 +60,7 @@ dev-mkdocs = [
"mkdocs-material == 9.5.27",
"mkdocstrings[python] == 0.25.1",
"mkdocstrings-python == 1.10.5",
"frequenz-repo-config[model] == 0.9.2",
"frequenz-repo-config[model] == 0.10.0",
]
dev-mypy = [
"mypy == 1.9.0",
Expand All @@ -70,7 +70,7 @@ dev-mypy = [
]
dev-noxfile = [
"nox == 2024.4.15",
"frequenz-repo-config[model] == 0.9.2",
"frequenz-repo-config[model] == 0.10.0",
]
dev-pylint = [
# dev-pytest already defines a dependency to pylint because of the examples
Expand All @@ -80,7 +80,7 @@ dev-pylint = [
dev-pytest = [
"pytest == 8.2.2",
"pylint == 3.2.5", # We need this to check for the examples
"frequenz-repo-config[extra-lint-examples] == 0.9.2",
"frequenz-repo-config[extra-lint-examples] == 0.10.0",
"pytest-mock == 3.14.0",
"pytest-asyncio == 0.23.7",
"async-solipsism == 0.6",
Expand Down

0 comments on commit 6aa6bc0

Please sign in to comment.