diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index becf28c6..bb433336 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -22,6 +22,7 @@ * API projects don't include the `google-common-protos` dependency by default. * API projects updated the `grpcio` dependency to `1.66.1`. * API projects updated the `frequenz-api-common` dependency to `0.6`. +* Change `edit_uri` default branch to v0.x.x in mkdocs.yml. ## Bug Fixes diff --git a/cookiecutter/{{cookiecutter.github_repo_name}}/mkdocs.yml b/cookiecutter/{{cookiecutter.github_repo_name}}/mkdocs.yml index 21eb3b26..176b1f49 100644 --- a/cookiecutter/{{cookiecutter.github_repo_name}}/mkdocs.yml +++ b/cookiecutter/{{cookiecutter.github_repo_name}}/mkdocs.yml @@ -8,9 +8,9 @@ site_author: "{{cookiecutter.author_name}}" copyright: "Copyright © {{copyright_year}} {{cookiecutter.author_name}}" repo_name: "{{cookiecutter.github_repo_name}}" repo_url: "https://github.com/{{cookiecutter.github_org}}/{{cookiecutter.github_repo_name}}" -# TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it +# TODO(cookiecutter): "v0.x.x" is the GitHub repo default branch, you might want to update it # if the project uses a different default branch. -edit_uri: "edit/main/docs/" +edit_uri: "edit/v0.x.x/docs/" strict: true # Treat warnings as errors # Build directories diff --git a/tests_golden/integration/test_cookiecutter_generation/actor/cookiecutter-stdout.txt b/tests_golden/integration/test_cookiecutter_generation/actor/cookiecutter-stdout.txt index b2d6c502..f4aaaaa2 100644 --- a/tests_golden/integration/test_cookiecutter_generation/actor/cookiecutter-stdout.txt +++ b/tests_golden/integration/test_cookiecutter_generation/actor/cookiecutter-stdout.txt @@ -16,7 +16,7 @@ ./mkdocs.yml: # TODO(cookiecutter): You might want to add other external references here ./mkdocs.yml: # TODO(cookiecutter): You might want to change the logo, the file is located in "docs/" ./mkdocs.yml: # TODO(cookiecutter): You probably want to update the social links -./mkdocs.yml:# TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it +./mkdocs.yml:# TODO(cookiecutter): "v0.x.x" is the GitHub repo default branch, you might want to update it ./pyproject.toml:# TODO(cookiecutter): Remove and add more classifiers if appropriate ./pyproject.toml:# TODO(cookiecutter): Remove and add more dependencies if appropriate ./pyproject.toml:# TODO(cookiecutter): Remove and add more optional dependencies if appropriate diff --git a/tests_golden/integration/test_cookiecutter_generation/actor/frequenz-actor-test/mkdocs.yml b/tests_golden/integration/test_cookiecutter_generation/actor/frequenz-actor-test/mkdocs.yml index ae4f9231..cf4afa48 100644 --- a/tests_golden/integration/test_cookiecutter_generation/actor/frequenz-actor-test/mkdocs.yml +++ b/tests_golden/integration/test_cookiecutter_generation/actor/frequenz-actor-test/mkdocs.yml @@ -8,9 +8,9 @@ site_author: "Frequenz Energy-as-a-Service GmbH" copyright: "Copyright © 2023 Frequenz Energy-as-a-Service GmbH" repo_name: "frequenz-actor-test" repo_url: "https://github.com/frequenz-floss/frequenz-actor-test" -# TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it +# TODO(cookiecutter): "v0.x.x" is the GitHub repo default branch, you might want to update it # if the project uses a different default branch. -edit_uri: "edit/main/docs/" +edit_uri: "edit/v0.x.x/docs/" strict: true # Treat warnings as errors # Build directories diff --git a/tests_golden/integration/test_cookiecutter_generation/api/cookiecutter-stdout.txt b/tests_golden/integration/test_cookiecutter_generation/api/cookiecutter-stdout.txt index 9f3e52f1..2ec694d7 100644 --- a/tests_golden/integration/test_cookiecutter_generation/api/cookiecutter-stdout.txt +++ b/tests_golden/integration/test_cookiecutter_generation/api/cookiecutter-stdout.txt @@ -16,7 +16,7 @@ ./mkdocs.yml: # TODO(cookiecutter): You might want to add other external references here ./mkdocs.yml: # TODO(cookiecutter): You might want to change the logo, the file is located in "docs/" ./mkdocs.yml: # TODO(cookiecutter): You probably want to update the social links -./mkdocs.yml:# TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it +./mkdocs.yml:# TODO(cookiecutter): "v0.x.x" is the GitHub repo default branch, you might want to update it ./proto/frequenz/api/test/test.proto:// TODO(cookiecutter): Add a more descriptive package description. ./proto/frequenz/api/test/test.proto:// TODO(cookiecutter): Remove this message. ./py/frequenz/api/test/__init__.py:TODO(cookiecutter): Add a more descriptive module description. diff --git a/tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test/mkdocs.yml b/tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test/mkdocs.yml index fea1965e..f02aa9d9 100644 --- a/tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test/mkdocs.yml +++ b/tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test/mkdocs.yml @@ -8,9 +8,9 @@ site_author: "Frequenz Energy-as-a-Service GmbH" copyright: "Copyright © 2023 Frequenz Energy-as-a-Service GmbH" repo_name: "frequenz-api-test" repo_url: "https://github.com/frequenz-floss/frequenz-api-test" -# TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it +# TODO(cookiecutter): "v0.x.x" is the GitHub repo default branch, you might want to update it # if the project uses a different default branch. -edit_uri: "edit/main/docs/" +edit_uri: "edit/v0.x.x/docs/" strict: true # Treat warnings as errors # Build directories diff --git a/tests_golden/integration/test_cookiecutter_generation/app/cookiecutter-stdout.txt b/tests_golden/integration/test_cookiecutter_generation/app/cookiecutter-stdout.txt index 36447a86..8a5abb01 100644 --- a/tests_golden/integration/test_cookiecutter_generation/app/cookiecutter-stdout.txt +++ b/tests_golden/integration/test_cookiecutter_generation/app/cookiecutter-stdout.txt @@ -15,7 +15,7 @@ ./mkdocs.yml: # TODO(cookiecutter): You might want to add other external references here ./mkdocs.yml: # TODO(cookiecutter): You might want to change the logo, the file is located in "docs/" ./mkdocs.yml: # TODO(cookiecutter): You probably want to update the social links -./mkdocs.yml:# TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it +./mkdocs.yml:# TODO(cookiecutter): "v0.x.x" is the GitHub repo default branch, you might want to update it ./pyproject.toml:# TODO(cookiecutter): Remove and add more classifiers if appropriate ./pyproject.toml:# TODO(cookiecutter): Remove and add more dependencies if appropriate ./pyproject.toml:# TODO(cookiecutter): Remove and add more optional dependencies if appropriate diff --git a/tests_golden/integration/test_cookiecutter_generation/app/frequenz-app-test/mkdocs.yml b/tests_golden/integration/test_cookiecutter_generation/app/frequenz-app-test/mkdocs.yml index 8ce71a0c..7e2a698e 100644 --- a/tests_golden/integration/test_cookiecutter_generation/app/frequenz-app-test/mkdocs.yml +++ b/tests_golden/integration/test_cookiecutter_generation/app/frequenz-app-test/mkdocs.yml @@ -8,9 +8,9 @@ site_author: "Frequenz Energy-as-a-Service GmbH" copyright: "Copyright © 2023 Frequenz Energy-as-a-Service GmbH" repo_name: "frequenz-app-test" repo_url: "https://github.com/frequenz-floss/frequenz-app-test" -# TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it +# TODO(cookiecutter): "v0.x.x" is the GitHub repo default branch, you might want to update it # if the project uses a different default branch. -edit_uri: "edit/main/docs/" +edit_uri: "edit/v0.x.x/docs/" strict: true # Treat warnings as errors # Build directories diff --git a/tests_golden/integration/test_cookiecutter_generation/lib/cookiecutter-stdout.txt b/tests_golden/integration/test_cookiecutter_generation/lib/cookiecutter-stdout.txt index db944150..77bc53b5 100644 --- a/tests_golden/integration/test_cookiecutter_generation/lib/cookiecutter-stdout.txt +++ b/tests_golden/integration/test_cookiecutter_generation/lib/cookiecutter-stdout.txt @@ -15,7 +15,7 @@ ./mkdocs.yml: # TODO(cookiecutter): You might want to add other external references here ./mkdocs.yml: # TODO(cookiecutter): You might want to change the logo, the file is located in "docs/" ./mkdocs.yml: # TODO(cookiecutter): You probably want to update the social links -./mkdocs.yml:# TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it +./mkdocs.yml:# TODO(cookiecutter): "v0.x.x" is the GitHub repo default branch, you might want to update it ./pyproject.toml:# TODO(cookiecutter): Remove and add more classifiers if appropriate ./pyproject.toml:# TODO(cookiecutter): Remove and add more dependencies if appropriate ./pyproject.toml:# TODO(cookiecutter): Remove and add more optional dependencies if appropriate diff --git a/tests_golden/integration/test_cookiecutter_generation/lib/frequenz-test-python/mkdocs.yml b/tests_golden/integration/test_cookiecutter_generation/lib/frequenz-test-python/mkdocs.yml index fc4666b5..7e268f79 100644 --- a/tests_golden/integration/test_cookiecutter_generation/lib/frequenz-test-python/mkdocs.yml +++ b/tests_golden/integration/test_cookiecutter_generation/lib/frequenz-test-python/mkdocs.yml @@ -8,9 +8,9 @@ site_author: "Frequenz Energy-as-a-Service GmbH" copyright: "Copyright © 2023 Frequenz Energy-as-a-Service GmbH" repo_name: "frequenz-test-python" repo_url: "https://github.com/frequenz-floss/frequenz-test-python" -# TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it +# TODO(cookiecutter): "v0.x.x" is the GitHub repo default branch, you might want to update it # if the project uses a different default branch. -edit_uri: "edit/main/docs/" +edit_uri: "edit/v0.x.x/docs/" strict: true # Treat warnings as errors # Build directories diff --git a/tests_golden/integration/test_cookiecutter_generation/model/cookiecutter-stdout.txt b/tests_golden/integration/test_cookiecutter_generation/model/cookiecutter-stdout.txt index 81a2d8d3..0ba3358d 100644 --- a/tests_golden/integration/test_cookiecutter_generation/model/cookiecutter-stdout.txt +++ b/tests_golden/integration/test_cookiecutter_generation/model/cookiecutter-stdout.txt @@ -15,7 +15,7 @@ ./mkdocs.yml: # TODO(cookiecutter): You might want to add other external references here ./mkdocs.yml: # TODO(cookiecutter): You might want to change the logo, the file is located in "docs/" ./mkdocs.yml: # TODO(cookiecutter): You probably want to update the social links -./mkdocs.yml:# TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it +./mkdocs.yml:# TODO(cookiecutter): "v0.x.x" is the GitHub repo default branch, you might want to update it ./pyproject.toml:# TODO(cookiecutter): Remove and add more classifiers if appropriate ./pyproject.toml:# TODO(cookiecutter): Remove and add more dependencies if appropriate ./pyproject.toml:# TODO(cookiecutter): Remove and add more optional dependencies if appropriate diff --git a/tests_golden/integration/test_cookiecutter_generation/model/frequenz-model-test/mkdocs.yml b/tests_golden/integration/test_cookiecutter_generation/model/frequenz-model-test/mkdocs.yml index 82aabe9b..9849e3b6 100644 --- a/tests_golden/integration/test_cookiecutter_generation/model/frequenz-model-test/mkdocs.yml +++ b/tests_golden/integration/test_cookiecutter_generation/model/frequenz-model-test/mkdocs.yml @@ -8,9 +8,9 @@ site_author: "Frequenz Energy-as-a-Service GmbH" copyright: "Copyright © 2023 Frequenz Energy-as-a-Service GmbH" repo_name: "frequenz-model-test" repo_url: "https://github.com/frequenz-floss/frequenz-model-test" -# TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it +# TODO(cookiecutter): "v0.x.x" is the GitHub repo default branch, you might want to update it # if the project uses a different default branch. -edit_uri: "edit/main/docs/" +edit_uri: "edit/v0.x.x/docs/" strict: true # Treat warnings as errors # Build directories