Update docs and template version

llucax · llucax · commit 59df518af6c3 · 2023-09-18T14:40:48.000+02:00
The version used in the documentation and generated Cookiecutter
templates were outdated (v0.5.2). Now they point to the latest
(upcoming) version (v0.6.2).

Signed-off-by: Leandro Lucarella &lt;luca-frequenz@llucax.com&gt;
diff --git a/README.md b/README.md
@@ -42,7 +42,7 @@ directory will be created with the generated project name. For example:
 cd ~/devel
 cookiecutter gh:frequenz-floss/frequenz-repo-config-python \
     --directory=cookiecutter \
-    --checkout v0.5.2
+    --checkout v0.6.2
 ```
 
 This command will prompt you for the project type, name, and other
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -1,29 +1,9 @@
 # Frequenz Repository Configuration Release Notes
 
-## Summary
-
-<!-- Here goes a general summary of what this release is about -->
-
-## 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 -->
-
-## New Features
-
-<!-- Here goes the main new features and examples or instructions on how to use them -->
-
-### Cookiecutter template
-
-<!-- Here new features for cookiecutter specifically -->
-
 ## Bug Fixes
 
-<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
+- Update the version used in the documentation.
 
 ### Cookiecutter template
 
-<!-- Here bug fixes for cookiecutter specifically -->
+- Update the generated version in dependencies.
diff --git a/cookiecutter/{{cookiecutter.github_repo_name}}/pyproject.toml b/cookiecutter/{{cookiecutter.github_repo_name}}/pyproject.toml
@@ -5,7 +5,7 @@
 requires = [
   "setuptools == 68.1.0",
   "setuptools_scm[toml] == 7.1.0",
-  "frequenz-repo-config[{{cookiecutter.type}}] == 0.5.2",
+  "frequenz-repo-config[{{cookiecutter.type}}] == 0.6.2",
 ]
 build-backend = "setuptools.build_meta"
 
@@ -75,7 +75,7 @@ dev-mkdocs = [
   "mkdocs-material == 9.1.21",
   "mkdocs-section-index == 0.3.5",
   "mkdocstrings[python] == 0.22.0",
-  "frequenz-repo-config[{{cookiecutter.type}}] == 0.5.2",
+  "frequenz-repo-config[{{cookiecutter.type}}] == 0.6.2",
 ]
 dev-mypy = [
   "mypy == 1.5.1",
@@ -87,7 +87,7 @@ dev-mypy = [
 ]
 dev-noxfile = [
   "nox == 2023.4.22",
-  "frequenz-repo-config[{{cookiecutter.type}}] == 0.5.2",
+  "frequenz-repo-config[{{cookiecutter.type}}] == 0.6.2",
 ]
 dev-pylint = [
   "pylint == 2.17.5",
@@ -96,7 +96,7 @@ dev-pylint = [
 ]
 dev-pytest = [
   "pytest == 7.4.0",
-  "frequenz-repo-config[extra-lint-examples] == 0.5.2",
+  "frequenz-repo-config[extra-lint-examples] == 0.6.2",
 {%- if cookiecutter.type != "api" %}
   "pytest-mock == 3.11.1",
   "pytest-asyncio == 0.21.1",
diff --git a/docs/index.md b/docs/index.md
@@ -35,7 +35,7 @@ Then simply run [Cookiecutter] where you want to create the new project:
 
 ```sh
 cookiecutter gh:frequenz-floss/frequenz-repo-config-python \
-    --directory=cookiecutter --checkout v0.5.2
+    --directory=cookiecutter --checkout v0.6.2
 ```
 
 This command will prompt you for the project type, name, and other
@@ -238,7 +238,7 @@ the files in your existing project by using `rsync` or similar tools:
 ```sh
 cd /tmp
 cookiecutter gh:frequenz-floss/frequenz-repo-config-python \
-    --directory=cookiecutter --checkout v0.5.2
+    --directory=cookiecutter --checkout v0.6.2
 rsync -vr --exclude=.git/ new-project/ /path/to/existing/project
 cd /path/to/existing/project
 git diff
@@ -283,7 +283,7 @@ git commit -a  # commit all changes
 cd ..
 cookiecutter gh:frequenz-floss/frequenz-repo-config-python \
     --directory=cookiecutter \
-    --checkout v0.5.2 \
+    --checkout v0.6.2 \
     --overwrite-if-exists \
     --replay \
     --replay-file project-directory/.cookiecutter-replay.json
diff --git a/src/frequenz/repo/config/__init__.py b/src/frequenz/repo/config/__init__.py
@@ -289,7 +289,7 @@
     # ...
     dev-pytest = [
         # ...
-        "frequenz-repo-config[extra-lint-examples] == 0.5.2",
+        "frequenz-repo-config[extra-lint-examples] == 0.6.2",
     ]
     # ...
     [[tool.mypy.overrides]]
@@ -402,7 +402,7 @@
 requires = [
   "setuptools >= 67.3.2, < 68",
   "setuptools_scm[toml] >= 7.1.0, < 8",
-  "frequenz-repo-config[api] >= 0.5.2, < 0.6.0",
+  "frequenz-repo-config[api] >= 0.6.2, < 0.7.0",
 ]
 build-backend = "setuptools.build_meta"
 
diff --git a/tests_golden/integration/test_cookiecutter_generation/actor/frequenz-actor-test/pyproject.toml b/tests_golden/integration/test_cookiecutter_generation/actor/frequenz-actor-test/pyproject.toml
@@ -5,7 +5,7 @@
 requires = [
   "setuptools == 68.1.0",
   "setuptools_scm[toml] == 7.1.0",
-  "frequenz-repo-config[actor] == 0.5.2",
+  "frequenz-repo-config[actor] == 0.6.2",
 ]
 build-backend = "setuptools.build_meta"
 
@@ -57,7 +57,7 @@ dev-mkdocs = [
   "mkdocs-material == 9.1.21",
   "mkdocs-section-index == 0.3.5",
   "mkdocstrings[python] == 0.22.0",
-  "frequenz-repo-config[actor] == 0.5.2",
+  "frequenz-repo-config[actor] == 0.6.2",
 ]
 dev-mypy = [
   "mypy == 1.5.1",
@@ -66,7 +66,7 @@ dev-mypy = [
 ]
 dev-noxfile = [
   "nox == 2023.4.22",
-  "frequenz-repo-config[actor] == 0.5.2",
+  "frequenz-repo-config[actor] == 0.6.2",
 ]
 dev-pylint = [
   "pylint == 2.17.5",
@@ -75,7 +75,7 @@ dev-pylint = [
 ]
 dev-pytest = [
   "pytest == 7.4.0",
-  "frequenz-repo-config[extra-lint-examples] == 0.5.2",
+  "frequenz-repo-config[extra-lint-examples] == 0.6.2",
   "pytest-mock == 3.11.1",
   "pytest-asyncio == 0.21.1",
   "async-solipsism == 0.5",
diff --git a/tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test/pyproject.toml b/tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test/pyproject.toml
@@ -5,7 +5,7 @@
 requires = [
   "setuptools == 68.1.0",
   "setuptools_scm[toml] == 7.1.0",
-  "frequenz-repo-config[api] == 0.5.2",
+  "frequenz-repo-config[api] == 0.6.2",
 ]
 build-backend = "setuptools.build_meta"
 
@@ -55,7 +55,7 @@ dev-mkdocs = [
   "mkdocs-material == 9.1.21",
   "mkdocs-section-index == 0.3.5",
   "mkdocstrings[python] == 0.22.0",
-  "frequenz-repo-config[api] == 0.5.2",
+  "frequenz-repo-config[api] == 0.6.2",
 ]
 dev-mypy = [
   "mypy == 1.5.1",
@@ -65,7 +65,7 @@ dev-mypy = [
 ]
 dev-noxfile = [
   "nox == 2023.4.22",
-  "frequenz-repo-config[api] == 0.5.2",
+  "frequenz-repo-config[api] == 0.6.2",
 ]
 dev-pylint = [
   "pylint == 2.17.5",
@@ -74,7 +74,7 @@ dev-pylint = [
 ]
 dev-pytest = [
   "pytest == 7.4.0",
-  "frequenz-repo-config[extra-lint-examples] == 0.5.2",
+  "frequenz-repo-config[extra-lint-examples] == 0.6.2",
 ]
 dev = [
   "frequenz-api-test[dev-mkdocs,dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]",
diff --git a/tests_golden/integration/test_cookiecutter_generation/app/frequenz-app-test/pyproject.toml b/tests_golden/integration/test_cookiecutter_generation/app/frequenz-app-test/pyproject.toml
@@ -5,7 +5,7 @@
 requires = [
   "setuptools == 68.1.0",
   "setuptools_scm[toml] == 7.1.0",
-  "frequenz-repo-config[app] == 0.5.2",
+  "frequenz-repo-config[app] == 0.6.2",
 ]
 build-backend = "setuptools.build_meta"
 
@@ -56,7 +56,7 @@ dev-mkdocs = [
   "mkdocs-material == 9.1.21",
   "mkdocs-section-index == 0.3.5",
   "mkdocstrings[python] == 0.22.0",
-  "frequenz-repo-config[app] == 0.5.2",
+  "frequenz-repo-config[app] == 0.6.2",
 ]
 dev-mypy = [
   "mypy == 1.5.1",
@@ -65,7 +65,7 @@ dev-mypy = [
 ]
 dev-noxfile = [
   "nox == 2023.4.22",
-  "frequenz-repo-config[app] == 0.5.2",
+  "frequenz-repo-config[app] == 0.6.2",
 ]
 dev-pylint = [
   "pylint == 2.17.5",
@@ -74,7 +74,7 @@ dev-pylint = [
 ]
 dev-pytest = [
   "pytest == 7.4.0",
-  "frequenz-repo-config[extra-lint-examples] == 0.5.2",
+  "frequenz-repo-config[extra-lint-examples] == 0.6.2",
   "pytest-mock == 3.11.1",
   "pytest-asyncio == 0.21.1",
   "async-solipsism == 0.5",
diff --git a/tests_golden/integration/test_cookiecutter_generation/lib/frequenz-test-python/pyproject.toml b/tests_golden/integration/test_cookiecutter_generation/lib/frequenz-test-python/pyproject.toml
@@ -5,7 +5,7 @@
 requires = [
   "setuptools == 68.1.0",
   "setuptools_scm[toml] == 7.1.0",
-  "frequenz-repo-config[lib] == 0.5.2",
+  "frequenz-repo-config[lib] == 0.6.2",
 ]
 build-backend = "setuptools.build_meta"
 
@@ -53,7 +53,7 @@ dev-mkdocs = [
   "mkdocs-material == 9.1.21",
   "mkdocs-section-index == 0.3.5",
   "mkdocstrings[python] == 0.22.0",
-  "frequenz-repo-config[lib] == 0.5.2",
+  "frequenz-repo-config[lib] == 0.6.2",
 ]
 dev-mypy = [
   "mypy == 1.5.1",
@@ -62,7 +62,7 @@ dev-mypy = [
 ]
 dev-noxfile = [
   "nox == 2023.4.22",
-  "frequenz-repo-config[lib] == 0.5.2",
+  "frequenz-repo-config[lib] == 0.6.2",
 ]
 dev-pylint = [
   "pylint == 2.17.5",
@@ -71,7 +71,7 @@ dev-pylint = [
 ]
 dev-pytest = [
   "pytest == 7.4.0",
-  "frequenz-repo-config[extra-lint-examples] == 0.5.2",
+  "frequenz-repo-config[extra-lint-examples] == 0.6.2",
   "pytest-mock == 3.11.1",
   "pytest-asyncio == 0.21.1",
   "async-solipsism == 0.5",
diff --git a/tests_golden/integration/test_cookiecutter_generation/model/frequenz-model-test/pyproject.toml b/tests_golden/integration/test_cookiecutter_generation/model/frequenz-model-test/pyproject.toml
@@ -5,7 +5,7 @@
 requires = [
   "setuptools == 68.1.0",
   "setuptools_scm[toml] == 7.1.0",
-  "frequenz-repo-config[model] == 0.5.2",
+  "frequenz-repo-config[model] == 0.6.2",
 ]
 build-backend = "setuptools.build_meta"
 
@@ -57,7 +57,7 @@ dev-mkdocs = [
   "mkdocs-material == 9.1.21",
   "mkdocs-section-index == 0.3.5",
   "mkdocstrings[python] == 0.22.0",
-  "frequenz-repo-config[model] == 0.5.2",
+  "frequenz-repo-config[model] == 0.6.2",
 ]
 dev-mypy = [
   "mypy == 1.5.1",
@@ -66,7 +66,7 @@ dev-mypy = [
 ]
 dev-noxfile = [
   "nox == 2023.4.22",
-  "frequenz-repo-config[model] == 0.5.2",
+  "frequenz-repo-config[model] == 0.6.2",
 ]
 dev-pylint = [
   "pylint == 2.17.5",
@@ -75,7 +75,7 @@ dev-pylint = [
 ]
 dev-pytest = [
   "pytest == 7.4.0",
-  "frequenz-repo-config[extra-lint-examples] == 0.5.2",
+  "frequenz-repo-config[extra-lint-examples] == 0.6.2",
   "pytest-mock == 3.11.1",
   "pytest-asyncio == 0.21.1",
   "async-solipsism == 0.5",

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`requires = [`
`6`	`6`	`"setuptools == 68.1.0",`
`7`	`7`	`"setuptools_scm[toml] == 7.1.0",`
`8`		`- "frequenz-repo-config[api] == 0.5.2",`
	`8`	`+ "frequenz-repo-config[api] == 0.6.2",`
`9`	`9`	`]`
`10`	`10`	`build-backend = "setuptools.build_meta"`
`11`	`11`
`@@ -55,7 +55,7 @@ dev-mkdocs = [`
`55`	`55`	`"mkdocs-material == 9.1.21",`
`56`	`56`	`"mkdocs-section-index == 0.3.5",`
`57`	`57`	`"mkdocstrings[python] == 0.22.0",`
`58`		`- "frequenz-repo-config[api] == 0.5.2",`
	`58`	`+ "frequenz-repo-config[api] == 0.6.2",`
`59`	`59`	`]`
`60`	`60`	`dev-mypy = [`
`61`	`61`	`"mypy == 1.5.1",`
`@@ -65,7 +65,7 @@ dev-mypy = [`
`65`	`65`	`]`
`66`	`66`	`dev-noxfile = [`
`67`	`67`	`"nox == 2023.4.22",`
`68`		`- "frequenz-repo-config[api] == 0.5.2",`
	`68`	`+ "frequenz-repo-config[api] == 0.6.2",`
`69`	`69`	`]`
`70`	`70`	`dev-pylint = [`
`71`	`71`	`"pylint == 2.17.5",`
`@@ -74,7 +74,7 @@ dev-pylint = [`
`74`	`74`	`]`
`75`	`75`	`dev-pytest = [`
`76`	`76`	`"pytest == 7.4.0",`
`77`		`- "frequenz-repo-config[extra-lint-examples] == 0.5.2",`
	`77`	`+ "frequenz-repo-config[extra-lint-examples] == 0.6.2",`
`78`	`78`	`]`
`79`	`79`	`dev = [`
`80`	`80`	`"frequenz-api-test[dev-mkdocs,dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]",`