Skip to content

Commit 323bf82

Browse files
llucaxllucax
authored
API: Add cross-linking to common-api and prepare for the release (frequenz-floss#122)
Now that we depend on common-api v0.3.x+ we can cross-link the documentation.
2 parents cbdc8ed + e90d717 commit 323bf82

File tree

12 files changed

+35
-38
lines changed

12 files changed

+35
-38
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ directory will be created with the generated project name. For example:
4242
cd ~/devel
4343
cookiecutter gh:frequenz-floss/frequenz-repo-config-python \
4444
--directory=cookiecutter \
45-
--checkout v0.5.1
45+
--checkout v0.5.2
4646
```
4747

4848
This command will prompt you for the project type, name, and other

‎RELEASE_NOTES.md‎

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,10 @@
22

33
## Summary
44

5-
<!-- Here goes a general summary of what this release is about -->
5+
This version focus on some bug fixes and final polishing of v0.5.x.
66

77
## Upgrading
88

9-
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
10-
119
### Cookiecutter template
1210

1311
- If your replay file contains a `_extensions` key, you should remove it, as you most likely want to use the extensions declared by the repo-config cookiecutter template you are upgrading to, otherwise you could get errors about missing extensions.
@@ -16,11 +14,8 @@
1614

1715
## New Features
1816

19-
<!-- Here goes the main new features and examples or instructions on how to use them -->
20-
2117
### Cookiecutter template
2218

23-
2419
- Generated project's dependencies were bumped.
2520

2621
- Move `TODO`s so they are in their own line.
@@ -41,9 +36,9 @@
4136

4237
This is just to be nice to most editors and text files conventions, that likes it more if there is a `\n` at the end of the file.
4338

44-
## Bug Fixes
39+
- API: The common-api documentation now is cross-linked.
4540

46-
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
41+
## Bug Fixes
4742

4843
### Cookiecutter template
4944

‎cookiecutter/{{cookiecutter.github_repo_name}}/mkdocs.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,7 @@ plugins:
114114
- https://frequenz-floss.github.io/frequenz-channels-python/v0.14/objects.inv
115115
- https://frequenz-floss.github.io/frequenz-sdk-python/v0.22/objects.inv
116116
{%- elif cookiecutter.type == "api" %}
117+
- https://frequenz-floss.github.io/frequenz-api-common/v0.3/objects.inv
117118
- https://grpc.github.io/grpc/python/objects.inv
118119
{%- endif %}
119120
- https://typing-extensions.readthedocs.io/en/stable/objects.inv

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

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

@@ -73,7 +73,7 @@ dev-mkdocs = [
7373
"mkdocs-material == 9.1.21",
7474
"mkdocs-section-index == 0.3.5",
7575
"mkdocstrings[python] == 0.22.0",
76-
"frequenz-repo-config[{{cookiecutter.type}}] == 0.5.1",
76+
"frequenz-repo-config[{{cookiecutter.type}}] == 0.5.2",
7777
]
7878
dev-mypy = [
7979
"mypy == 1.5.1",
@@ -82,7 +82,7 @@ dev-mypy = [
8282
]
8383
dev-noxfile = [
8484
"nox == 2023.4.22",
85-
"frequenz-repo-config[{{cookiecutter.type}}] == 0.5.1",
85+
"frequenz-repo-config[{{cookiecutter.type}}] == 0.5.2",
8686
]
8787
dev-pylint = [
8888
"pylint == 2.17.5",
@@ -91,7 +91,7 @@ dev-pylint = [
9191
]
9292
dev-pytest = [
9393
"pytest == 7.4.0",
94-
"frequenz-repo-config[extra-lint-examples] == 0.5.1",
94+
"frequenz-repo-config[extra-lint-examples] == 0.5.2",
9595
{%- if cookiecutter.type != "api" %}
9696
"pytest-mock == 3.11.1",
9797
"pytest-asyncio == 0.21.1",

‎docs/index.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Then simply run [Cookiecutter] where you want to create the new project:
3535

3636
```sh
3737
cookiecutter gh:frequenz-floss/frequenz-repo-config-python \
38-
--directory=cookiecutter --checkout v0.5.1
38+
--directory=cookiecutter --checkout v0.5.2
3939
```
4040

4141
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:
238238
```sh
239239
cd /tmp
240240
cookiecutter gh:frequenz-floss/frequenz-repo-config-python \
241-
--directory=cookiecutter --checkout v0.5.1
241+
--directory=cookiecutter --checkout v0.5.2
242242
rsync -vr --exclude=.git/ new-project/ /path/to/existing/project
243243
cd /path/to/existing/project
244244
git diff
@@ -283,7 +283,7 @@ git commit -a # commit all changes
283283
cd ..
284284
cookiecutter gh:frequenz-floss/frequenz-repo-config-python \
285285
--directory=cookiecutter \
286-
--checkout v0.5.1 \
286+
--checkout v0.5.2 \
287287
--overwrite-if-exists \
288288
--replay \
289289
--replay-file project-directory/.cookiecutter-replay.json

‎src/frequenz/repo/config/__init__.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@
244244
# ...
245245
dev-pytest = [
246246
# ...
247-
"frequenz-repo-config[extra-lint-examples] == 0.5.1",
247+
"frequenz-repo-config[extra-lint-examples] == 0.5.2",
248248
]
249249
# ...
250250
[[tool.mypy.overrides]]
@@ -357,7 +357,7 @@
357357
requires = [
358358
"setuptools >= 67.3.2, < 68",
359359
"setuptools_scm[toml] >= 7.1.0, < 8",
360-
"frequenz-repo-config[api] >= 0.5.1, < 0.6.0",
360+
"frequenz-repo-config[api] >= 0.5.2, < 0.6.0",
361361
]
362362
build-backend = "setuptools.build_meta"
363363

‎tests_golden/integration/test_cookiecutter_generation/actor/frequenz-actor-test/pyproject.toml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
requires = [
66
"setuptools == 68.1.0",
77
"setuptools_scm[toml] == 7.1.0",
8-
"frequenz-repo-config[actor] == 0.5.1",
8+
"frequenz-repo-config[actor] == 0.5.2",
99
]
1010
build-backend = "setuptools.build_meta"
1111

@@ -55,7 +55,7 @@ dev-mkdocs = [
5555
"mkdocs-material == 9.1.21",
5656
"mkdocs-section-index == 0.3.5",
5757
"mkdocstrings[python] == 0.22.0",
58-
"frequenz-repo-config[actor] == 0.5.1",
58+
"frequenz-repo-config[actor] == 0.5.2",
5959
]
6060
dev-mypy = [
6161
"mypy == 1.5.1",
@@ -64,7 +64,7 @@ dev-mypy = [
6464
]
6565
dev-noxfile = [
6666
"nox == 2023.4.22",
67-
"frequenz-repo-config[actor] == 0.5.1",
67+
"frequenz-repo-config[actor] == 0.5.2",
6868
]
6969
dev-pylint = [
7070
"pylint == 2.17.5",
@@ -73,7 +73,7 @@ dev-pylint = [
7373
]
7474
dev-pytest = [
7575
"pytest == 7.4.0",
76-
"frequenz-repo-config[extra-lint-examples] == 0.5.1",
76+
"frequenz-repo-config[extra-lint-examples] == 0.5.2",
7777
"pytest-mock == 3.11.1",
7878
"pytest-asyncio == 0.21.1",
7979
"async-solipsism == 0.5",

‎tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test/mkdocs.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,7 @@ plugins:
110110
# TODO(cookiecutter): You might want to add other external references here
111111
# See https://mkdocstrings.github.io/python/usage/#import for details
112112
- https://docs.python.org/3/objects.inv
113+
- https://frequenz-floss.github.io/frequenz-api-common/v0.3/objects.inv
113114
- https://grpc.github.io/grpc/python/objects.inv
114115
- https://typing-extensions.readthedocs.io/en/stable/objects.inv
115116
- search

‎tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test/pyproject.toml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
requires = [
66
"setuptools == 68.1.0",
77
"setuptools_scm[toml] == 7.1.0",
8-
"frequenz-repo-config[api] == 0.5.1",
8+
"frequenz-repo-config[api] == 0.5.2",
99
]
1010
build-backend = "setuptools.build_meta"
1111

@@ -53,7 +53,7 @@ dev-mkdocs = [
5353
"mkdocs-material == 9.1.21",
5454
"mkdocs-section-index == 0.3.5",
5555
"mkdocstrings[python] == 0.22.0",
56-
"frequenz-repo-config[api] == 0.5.1",
56+
"frequenz-repo-config[api] == 0.5.2",
5757
]
5858
dev-mypy = [
5959
"mypy == 1.5.1",
@@ -62,7 +62,7 @@ dev-mypy = [
6262
]
6363
dev-noxfile = [
6464
"nox == 2023.4.22",
65-
"frequenz-repo-config[api] == 0.5.1",
65+
"frequenz-repo-config[api] == 0.5.2",
6666
]
6767
dev-pylint = [
6868
"pylint == 2.17.5",
@@ -71,7 +71,7 @@ dev-pylint = [
7171
]
7272
dev-pytest = [
7373
"pytest == 7.4.0",
74-
"frequenz-repo-config[extra-lint-examples] == 0.5.1",
74+
"frequenz-repo-config[extra-lint-examples] == 0.5.2",
7575
]
7676
dev = [
7777
"frequenz-api-test[dev-mkdocs,dev-docstrings,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]",

‎tests_golden/integration/test_cookiecutter_generation/app/frequenz-app-test/pyproject.toml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
requires = [
66
"setuptools == 68.1.0",
77
"setuptools_scm[toml] == 7.1.0",
8-
"frequenz-repo-config[app] == 0.5.1",
8+
"frequenz-repo-config[app] == 0.5.2",
99
]
1010
build-backend = "setuptools.build_meta"
1111

@@ -54,7 +54,7 @@ dev-mkdocs = [
5454
"mkdocs-material == 9.1.21",
5555
"mkdocs-section-index == 0.3.5",
5656
"mkdocstrings[python] == 0.22.0",
57-
"frequenz-repo-config[app] == 0.5.1",
57+
"frequenz-repo-config[app] == 0.5.2",
5858
]
5959
dev-mypy = [
6060
"mypy == 1.5.1",
@@ -63,7 +63,7 @@ dev-mypy = [
6363
]
6464
dev-noxfile = [
6565
"nox == 2023.4.22",
66-
"frequenz-repo-config[app] == 0.5.1",
66+
"frequenz-repo-config[app] == 0.5.2",
6767
]
6868
dev-pylint = [
6969
"pylint == 2.17.5",
@@ -72,7 +72,7 @@ dev-pylint = [
7272
]
7373
dev-pytest = [
7474
"pytest == 7.4.0",
75-
"frequenz-repo-config[extra-lint-examples] == 0.5.1",
75+
"frequenz-repo-config[extra-lint-examples] == 0.5.2",
7676
"pytest-mock == 3.11.1",
7777
"pytest-asyncio == 0.21.1",
7878
"async-solipsism == 0.5",

0 commit comments

Comments
 (0)