Skip to content

Commit f0cd840

Browse files
authored
Update templates to v0.3.0 (#73)
- Clear release notes - Bump repo-config versoin in templates and docs
2 parents 6b25a6d + 45ed22e commit f0cd840

File tree

3 files changed

+7
-30
lines changed

3 files changed

+7
-30
lines changed

RELEASE_NOTES.md

Lines changed: 4 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,39 +2,16 @@
22

33
## Summary
44

5-
This release is a major step and adds many features and breaking changes.
5+
<!-- Here goes a general summary of what this release is about -->
66

77
## Upgrading
88

9-
Since this project is still in heavy development, the easiest way to upgrade is
10-
to regenerate the templates. Please follow the instructions in the new
11-
documentation website about [updating
12-
projects](https://frequenz-floss.github.io/frequenz-repo-config-python/next/#update-an-existing-project).
9+
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
1310

1411
## New Features
1512

16-
This is just a quick (non-comprehensive) summary of the new features:
17-
18-
* Add `--diff` as a default argument for `isort`
19-
* Improve `README`
20-
* Don't import modules into packages
21-
* Support migrating and updating existing projects with Cookiecutter
22-
* Cookiecutter template
23-
24-
* Add `dependabot` configuration
25-
* Add issue templates, keyword labeler, and PR labeler
26-
* Add `CODEOWNERS` file
27-
* Add `direnv`-related files to `.gitignore`
28-
* Add GitHub CI workflow to `cookiecutter`
29-
* Add `CONTRIBUTING` guide to `cookiecutter`
30-
* Add `RELEASE_NOTES` to `cookiecutter`
31-
* Add support to generate documentation using `mkdocs`
32-
33-
* Apply all the Cookiecutter template improvements to this project
13+
<!-- Here goes the main new features and examples or instructions on how to use them -->
3414

3515
## Bug Fixes
3616

37-
This is just a quick (non-comprehensive) summary of bug fixes:
38-
39-
* Fix some comments about creating labels
40-
* Fix tests
17+
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->

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

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

@@ -75,7 +75,7 @@ dev-mypy = [
7575
]
7676
dev-noxfile = [
7777
"nox == 2023.4.22",
78-
"frequenz-repo-config[{{cookiecutter.type}}] == 0.2.0",
78+
"frequenz-repo-config[{{cookiecutter.type}}] == 0.3.0",
7979
]
8080
dev-pylint = [
8181
"pylint == 2.17.3",

src/frequenz/repo/config/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -286,7 +286,7 @@
286286
requires = [
287287
"setuptools >= 67.3.2, < 68",
288288
"setuptools_scm[toml] >= 7.1.0, < 8",
289-
"frequenz-repo-config[api] >= 0.1.0, < 0.2.0",
289+
"frequenz-repo-config[api] >= 0.1.0, < 0.3.0",
290290
]
291291
build-backend = "setuptools.build_meta"
292292

0 commit comments

Comments
 (0)