Skip to content

Commit 778cd54

Browse files
Apply migration from 0.18.0 to 0.19.0
=== v0.19.0 ========================================================= Script URL: https://raw.githubusercontent.com/frequenz-floss/frequenz-repo-config-python/v0.19.0/cookiecutter/migrate.py ======================================================================== Enabling exhaustive match checks for mypy... Updated pyproject.toml: enabled exhaustive-match ======================================================================== ======================================================================== Removing default `-vv` from pytest addopts... Updated pyproject.toml: removed default `-vv` from [tool.pytest.ini_options] ======================================================================== Removing the dummy DCO merge-queue workflow... Removed .github/workflows/dco-merge-queue.yml ======================================================================== Pinning the DCO check in the 'Protect version branches' ruleset... Ruleset 'Protect version branches' is already up to date ======================================================================== ======================================================================== Updating pinned build dependencies... Skipped pyproject.toml: build dependencies already up to date ======================================================================== ======================================================================== Enabling asyncio debug mode for pytest... Updated pyproject.toml: enabled asyncio debug mode under [tool.pytest.ini_options] ======================================================================== ======================================================================== Updating the release instructions in CONTRIBUTING.md... Updated CONTRIBUTING.md: refreshed the release instructions ======================================================================== ✅ Migration script finished successfully ✅ The migration completed successfully. Applied-by: frequenz-floss/gh-action-dependabot-migrate
1 parent f6c1dfd commit 778cd54

3 files changed

Lines changed: 19 additions & 18 deletions

File tree

.github/workflows/dco-merge-queue.yml

Lines changed: 0 additions & 14 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Or you can use `nox`:
5353
nox -R -s pytest -- tests/test_*.py
5454
```
5555

56-
The same appliest to `pylint` or `mypy` for example:
56+
The same applies to `pylint` or `mypy` for example:
5757

5858
```sh
5959
nox -R -s pylint -- tests/test_*.py
@@ -121,12 +121,19 @@ These are the steps to create a new release:
121121

122122
1. Get the latest head you want to create a release from.
123123

124+
If you use milestones, check that the milestone for this release has no open
125+
issues left, and move whatever won't make it to a later milestone.
126+
124127
2. Update the `RELEASE_NOTES.md` file if it is not complete, up to date, and
125-
remove template comments (`<!-- ... ->`) and empty sections. Submit a pull
128+
remove template comments (`<!-- ... -->`) and empty sections. Submit a pull
126129
request if an update is needed, wait until it is merged, and update the
127130
latest head you want to create a release from to get the new merged pull
128131
request.
129132

133+
This can't be left for later: the notes published with the release are read
134+
from the `RELEASE_NOTES.md` committed at the tagged commit, not from the tag
135+
message.
136+
130137
3. Create a new signed tag using the release notes and
131138
a [semver](https://semver.org/) compatible version number with a `v` prefix,
132139
for example:
@@ -135,6 +142,10 @@ These are the steps to create a new release:
135142
git tag -s --cleanup=whitespace -F RELEASE_NOTES.md v0.0.1
136143
```
137144

145+
The signature is not optional: the *Protect released tags* ruleset rejects
146+
unsigned tags. It also forbids updating or deleting a released tag, so make
147+
sure you are tagging the commit you want.
148+
138149
4. Push the new tag.
139150

140151
5. A GitHub action will test the tag and if all goes well it will create
@@ -153,4 +164,7 @@ These are the steps to create a new release:
153164
Commit the new release notes and create a PR (this step should be automated
154165
eventually too).
155166

156-
7. Celebrate!
167+
7. If you use milestones, close the milestone for this release, and create the
168+
next one if it doesn't exist yet.
169+
170+
8. Celebrate!

pyproject.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,13 +185,14 @@ filterwarnings = [
185185
# chars as this is a regex
186186
'ignore:Protobuf gencode version .*exactly one major version older.*:UserWarning',
187187
]
188-
addopts = "-vv"
189188
testpaths = ["tests", "src"]
189+
asyncio_debug = true
190190
asyncio_mode = "auto"
191191
asyncio_default_fixture_loop_scope = "function"
192192
required_plugins = ["pytest-asyncio", "pytest-mock"]
193193

194194
[tool.mypy]
195+
enable_error_code = ["exhaustive-match"]
195196
explicit_package_bases = true
196197
namespace_packages = true
197198
# This option disables mypy cache, and it is sometimes useful to enable it if

0 commit comments

Comments
 (0)