Skip to content

Commit 6aaa39d

Browse files
llucaxllucax
authored
Update link in cookiecutter end instructions (#360)
Fixes #359 The link was pointing to a Wiki page that doesn't exist anymore.
2 parents 4aba551 + 23cd06a commit 6aaa39d

File tree

13 files changed

+32
-62
lines changed

13 files changed

+32
-62
lines changed

‎RELEASE_NOTES.md‎

Lines changed: 1 addition & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,7 @@
11
# Frequenz Repository Configuration Release Notes
22

3-
## Summary
4-
5-
<!-- Here goes a general summary of what this release is about -->
6-
7-
## Upgrading
8-
9-
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
10-
11-
### Cookiecutter template
12-
13-
All upgrading should be done via the migration script or regenerating the templates.
14-
15-
```bash
16-
curl -sSL https://raw.githubusercontent.com/frequenz-floss/frequenz-repo-config-python/v0.12/cookiecutter/migrate.py | python3
17-
```
18-
19-
But you might still need to adapt your code:
20-
21-
<!-- Here upgrade steps for cookiecutter specifically -->
22-
23-
## New Features
24-
25-
<!-- Here goes the main new features and examples or instructions on how to use them -->
26-
27-
### Cookiecutter template
28-
29-
<!-- Here new features for cookiecutter specifically -->
30-
313
## Bug Fixes
324

33-
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
34-
355
### Cookiecutter template
366

37-
<!-- Here bug fixes for cookiecutter specifically -->
7+
- Fixed an outdated link to instructions on how to continue when the cookiecutter template generation finishes.

‎cookiecutter/hooks/post_gen_project.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -476,8 +476,8 @@ def print_todos() -> None:
476476
print()
477477
note(
478478
"Make sure to (create and) configure your GitHub repository too: "
479-
"https://github.com/frequenz-floss/frequenz-repo-config-python/"
480-
"wiki/Configuring-a-new-GitHub-repository"
479+
"https://frequenz-floss.github.io/frequenz-repo-config-python/"
480+
"latest/user-guide/start-a-new-project/configure-github/"
481481
)
482482

483483

‎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 == 75.8.0",
77
"setuptools_scm[toml] == 8.1.0",
8-
"frequenz-repo-config[{{cookiecutter.type}}] == 0.12.2",
8+
"frequenz-repo-config[{{cookiecutter.type}}] == 0.12.3",
99
{%- if cookiecutter.type == "api" %}
1010
# We need to pin the protobuf, grpcio and grpcio-tools dependencies to make
1111
# sure the code is generated using the minimum supported versions, as older
@@ -101,7 +101,7 @@ dev-mkdocs = [
101101
"mkdocs-material == 9.6.2",
102102
"mkdocstrings[python] == 0.28.0",
103103
"mkdocstrings-python == 1.14.6",
104-
"frequenz-repo-config[{{cookiecutter.type}}] == 0.12.2",
104+
"frequenz-repo-config[{{cookiecutter.type}}] == 0.12.3",
105105
]
106106
dev-mypy = [
107107
"mypy == 1.9.0",
@@ -114,7 +114,7 @@ dev-mypy = [
114114
]
115115
dev-noxfile = [
116116
"nox == 2024.10.9",
117-
"frequenz-repo-config[{{cookiecutter.type}}] == 0.12.2",
117+
"frequenz-repo-config[{{cookiecutter.type}}] == 0.12.3",
118118
]
119119
dev-pylint = [
120120
# dev-pytest already defines a dependency to pylint because of the examples
@@ -124,7 +124,7 @@ dev-pylint = [
124124
dev-pytest = [
125125
"pytest == 8.3.4",
126126
"pylint == 3.3.4", # We need this to check for the examples
127-
"frequenz-repo-config[extra-lint-examples] == 0.12.2",
127+
"frequenz-repo-config[extra-lint-examples] == 0.12.3",
128128
{%- if cookiecutter.type != "api" %}
129129
"pytest-mock == 3.14.0",
130130
"pytest-asyncio == 0.25.3",

‎tests_golden/integration/test_cookiecutter_generation/actor/cookiecutter-stdout.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030

3131
Here is a list of things that should be reviewed and FIXED:
3232

33-
Make sure to (create and) configure your GitHub repository too: https://github.com/frequenz-floss/frequenz-repo-config-python/wiki/Configuring-a-new-GitHub-repository
33+
Make sure to (create and) configure your GitHub repository too: https://frequenz-floss.github.io/frequenz-repo-config-python/latest/user-guide/start-a-new-project/configure-github/
3434

3535
After completing it you can amend the previous commit using `git commit --amend` or create a new commit for the changes using `git commit`.
3636

‎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 == 75.8.0",
77
"setuptools_scm[toml] == 8.1.0",
8-
"frequenz-repo-config[actor] == 0.12.2",
8+
"frequenz-repo-config[actor] == 0.12.3",
99
]
1010
build-backend = "setuptools.build_meta"
1111

@@ -60,7 +60,7 @@ dev-mkdocs = [
6060
"mkdocs-material == 9.6.2",
6161
"mkdocstrings[python] == 0.28.0",
6262
"mkdocstrings-python == 1.14.6",
63-
"frequenz-repo-config[actor] == 0.12.2",
63+
"frequenz-repo-config[actor] == 0.12.3",
6464
]
6565
dev-mypy = [
6666
"mypy == 1.9.0",
@@ -70,7 +70,7 @@ dev-mypy = [
7070
]
7171
dev-noxfile = [
7272
"nox == 2024.10.9",
73-
"frequenz-repo-config[actor] == 0.12.2",
73+
"frequenz-repo-config[actor] == 0.12.3",
7474
]
7575
dev-pylint = [
7676
# dev-pytest already defines a dependency to pylint because of the examples
@@ -80,7 +80,7 @@ dev-pylint = [
8080
dev-pytest = [
8181
"pytest == 8.3.4",
8282
"pylint == 3.3.4", # We need this to check for the examples
83-
"frequenz-repo-config[extra-lint-examples] == 0.12.2",
83+
"frequenz-repo-config[extra-lint-examples] == 0.12.3",
8484
"pytest-mock == 3.14.0",
8585
"pytest-asyncio == 0.25.3",
8686
"async-solipsism == 0.7",

‎tests_golden/integration/test_cookiecutter_generation/api/cookiecutter-stdout.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929

3030
Here is a list of things that should be reviewed and FIXED:
3131

32-
Make sure to (create and) configure your GitHub repository too: https://github.com/frequenz-floss/frequenz-repo-config-python/wiki/Configuring-a-new-GitHub-repository
32+
Make sure to (create and) configure your GitHub repository too: https://frequenz-floss.github.io/frequenz-repo-config-python/latest/user-guide/start-a-new-project/configure-github/
3333

3434
After completing it you can amend the previous commit using `git commit --amend` or create a new commit for the changes using `git commit`.
3535

‎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 == 75.8.0",
77
"setuptools_scm[toml] == 8.1.0",
8-
"frequenz-repo-config[api] == 0.12.2",
8+
"frequenz-repo-config[api] == 0.12.3",
99
# We need to pin the protobuf, grpcio and grpcio-tools dependencies to make
1010
# sure the code is generated using the minimum supported versions, as older
1111
# versions can't work with code that was generated with newer versions.
@@ -71,7 +71,7 @@ dev-mkdocs = [
7171
"mkdocs-material == 9.6.2",
7272
"mkdocstrings[python] == 0.28.0",
7373
"mkdocstrings-python == 1.14.6",
74-
"frequenz-repo-config[api] == 0.12.2",
74+
"frequenz-repo-config[api] == 0.12.3",
7575
]
7676
dev-mypy = [
7777
"mypy == 1.9.0",
@@ -82,7 +82,7 @@ dev-mypy = [
8282
]
8383
dev-noxfile = [
8484
"nox == 2024.10.9",
85-
"frequenz-repo-config[api] == 0.12.2",
85+
"frequenz-repo-config[api] == 0.12.3",
8686
]
8787
dev-pylint = [
8888
# dev-pytest already defines a dependency to pylint because of the examples
@@ -92,7 +92,7 @@ dev-pylint = [
9292
dev-pytest = [
9393
"pytest == 8.3.4",
9494
"pylint == 3.3.4", # We need this to check for the examples
95-
"frequenz-repo-config[extra-lint-examples] == 0.12.2",
95+
"frequenz-repo-config[extra-lint-examples] == 0.12.3",
9696
]
9797
dev = [
9898
"frequenz-api-test[dev-mkdocs,dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]",

‎tests_golden/integration/test_cookiecutter_generation/app/cookiecutter-stdout.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929

3030
Here is a list of things that should be reviewed and FIXED:
3131

32-
Make sure to (create and) configure your GitHub repository too: https://github.com/frequenz-floss/frequenz-repo-config-python/wiki/Configuring-a-new-GitHub-repository
32+
Make sure to (create and) configure your GitHub repository too: https://frequenz-floss.github.io/frequenz-repo-config-python/latest/user-guide/start-a-new-project/configure-github/
3333

3434
After completing it you can amend the previous commit using `git commit --amend` or create a new commit for the changes using `git commit`.
3535

‎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 == 75.8.0",
77
"setuptools_scm[toml] == 8.1.0",
8-
"frequenz-repo-config[app] == 0.12.2",
8+
"frequenz-repo-config[app] == 0.12.3",
99
]
1010
build-backend = "setuptools.build_meta"
1111

@@ -59,7 +59,7 @@ dev-mkdocs = [
5959
"mkdocs-material == 9.6.2",
6060
"mkdocstrings[python] == 0.28.0",
6161
"mkdocstrings-python == 1.14.6",
62-
"frequenz-repo-config[app] == 0.12.2",
62+
"frequenz-repo-config[app] == 0.12.3",
6363
]
6464
dev-mypy = [
6565
"mypy == 1.9.0",
@@ -69,7 +69,7 @@ dev-mypy = [
6969
]
7070
dev-noxfile = [
7171
"nox == 2024.10.9",
72-
"frequenz-repo-config[app] == 0.12.2",
72+
"frequenz-repo-config[app] == 0.12.3",
7373
]
7474
dev-pylint = [
7575
# dev-pytest already defines a dependency to pylint because of the examples
@@ -79,7 +79,7 @@ dev-pylint = [
7979
dev-pytest = [
8080
"pytest == 8.3.4",
8181
"pylint == 3.3.4", # We need this to check for the examples
82-
"frequenz-repo-config[extra-lint-examples] == 0.12.2",
82+
"frequenz-repo-config[extra-lint-examples] == 0.12.3",
8383
"pytest-mock == 3.14.0",
8484
"pytest-asyncio == 0.25.3",
8585
"async-solipsism == 0.7",

‎tests_golden/integration/test_cookiecutter_generation/lib/cookiecutter-stdout.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929

3030
Here is a list of things that should be reviewed and FIXED:
3131

32-
Make sure to (create and) configure your GitHub repository too: https://github.com/frequenz-floss/frequenz-repo-config-python/wiki/Configuring-a-new-GitHub-repository
32+
Make sure to (create and) configure your GitHub repository too: https://frequenz-floss.github.io/frequenz-repo-config-python/latest/user-guide/start-a-new-project/configure-github/
3333

3434
After completing it you can amend the previous commit using `git commit --amend` or create a new commit for the changes using `git commit`.
3535

0 commit comments

Comments
 (0)