diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 35bfdee8..102d7e21 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -53,7 +53,7 @@ Or you can use `nox`: nox -R -s pytest -- tests/test_*.py ``` -The same appliest to `pylint` or `mypy` for example: +The same applies to `pylint` or `mypy` for example: ```sh nox -R -s pylint -- tests/test_*.py @@ -127,12 +127,19 @@ These are the steps to create a new release: 1. Get the latest head you want to create a release from. + If you use milestones, check that the milestone for this release has no open + issues left, and move whatever won't make it to a later milestone. + 2. Update the `RELEASE_NOTES.md` file if it is not complete, up to date, and - remove template comments (``) and empty sections. Submit a pull request if an update is needed, wait until it is merged, and update the latest head you want to create a release from to get the new merged pull request. + This can't be left for later: the notes published with the release are read + from the `RELEASE_NOTES.md` committed at the tagged commit, not from the tag + message. + 3. Create a new signed tag using the release notes and a [semver](https://semver.org/) compatible version number with a `v` prefix, for example: @@ -141,6 +148,10 @@ These are the steps to create a new release: git tag -s --cleanup=whitespace -F RELEASE_NOTES.md v0.0.1 ``` + The signature is not optional: the *Protect released tags* ruleset rejects + unsigned tags. It also forbids updating or deleting a released tag, so make + sure you are tagging the commit you want. + 4. Push the new tag. 5. A GitHub action will test the tag and if all goes well it will create @@ -159,4 +170,7 @@ These are the steps to create a new release: Commit the new release notes and create a PR (this step should be automated eventually too). -7. Celebrate! +7. If you use milestones, close the milestone for this release, and create the + next one if it doesn't exist yet. + +8. Celebrate! diff --git a/pyproject.toml b/pyproject.toml index b10e401b..0cdccdac 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,7 +5,7 @@ requires = [ "setuptools == 84.0.0", "setuptools_scm[toml] == 10.2.1", - "frequenz-repo-config[lib] == 0.18.0", + "frequenz-repo-config[lib] == 0.19.0", ] build-backend = "setuptools.build_meta" @@ -57,7 +57,7 @@ dev-mkdocs = [ "mkdocs-material == 9.7.7", "mkdocstrings[python] == 1.0.6", "mkdocstrings-python == 2.0.7", - "frequenz-repo-config[lib] == 0.18.0", + "frequenz-repo-config[lib] == 0.19.0", ] dev-mypy = [ "mypy == 2.3.1", @@ -66,7 +66,7 @@ dev-mypy = [ # For checking the noxfile, docs/ script, and tests "frequenz-client-common[dev-mkdocs,dev-noxfile,dev-pytest]", ] -dev-noxfile = ["nox == 2026.8.17", "frequenz-repo-config[lib] == 0.18.0"] +dev-noxfile = ["nox == 2026.8.17", "frequenz-repo-config[lib] == 0.19.0"] dev-pylint = [ "pylint == 4.0.8", # For checking the noxfile, docs/ script, and tests @@ -74,7 +74,7 @@ dev-pylint = [ ] dev-pytest = [ "pytest == 9.1.1", - "frequenz-repo-config[extra-lint-examples] == 0.18.0", + "frequenz-repo-config[extra-lint-examples] == 0.19.0", "hypothesis == 6.165.10", "pytest-mock == 3.15.1", "pytest-asyncio == 1.4.0", @@ -164,11 +164,13 @@ filterwarnings = [ 'ignore:Protobuf gencode version .*exactly one major version older.*:UserWarning', ] testpaths = ["tests", "src"] +asyncio_debug = true asyncio_mode = "auto" asyncio_default_fixture_loop_scope = "function" required_plugins = ["pytest-asyncio", "pytest-mock"] [tool.mypy] +enable_error_code = ["exhaustive-match"] explicit_package_bases = true namespace_packages = true # This option disables mypy cache, and it is sometimes useful to enable it if