Skip to content

Commit 9e226e5

Browse files
committed
Add line to update cross-refs in mkdocs.yml
When updating the version of `frequenz-api-common` dependency we also need to update the link to the inventory for cross-references in `mkdocs.yml` to point to the new version. Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 6d36702 commit 9e226e5

File tree

2 files changed

+4
-1
lines changed
  • cookiecutter/{{cookiecutter.github_repo_name}}
  • tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test

2 files changed

+4
-1
lines changed

cookiecutter/{{cookiecutter.github_repo_name}}/CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ git checkout v${ver}
8383
cd -
8484

8585
sed 's/frequenz-api-common == [0-9]\.[0-9]\.[0-9]/frequenz-api-common == '"${ver}/" -i pyproject.toml
86+
sed 's|https://frequenz-floss.github.io/frequenz-api-common/v[0-9]\.[0-9]/objects.inv|https://frequenz-floss.github.io/frequenz-api-common/v'${ver_minor}'/objects.inv|' -i mkdocs.yml
8687
```
8788
{%- endif %}
8889

tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test/CONTRIBUTING.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,13 +70,15 @@ Here is an example of upgrading the `frequenz-api-common` dependency to version
7070
`v0.2.0`:
7171
```sh
7272
ver="0.2.0"
73+
ver_minor=$(echo $ver | cut -d. -f1,2)
7374

7475
cd submodules/frequenz-api-common
7576
git remote update
7677
git checkout v${ver}
7778
cd -
7879

79-
sed s/"frequenz-api-common == [0-9]\.[0-9]\.[0-9]"/"frequenz-api-common == ${ver}"/g -i pyproject.toml
80+
sed 's/frequenz-api-common == [0-9]\.[0-9]\.[0-9]/frequenz-api-common == '"${ver}/" -i pyproject.toml
81+
sed 's|https://frequenz-floss.github.io/frequenz-api-common/v[0-9]\.[0-9]/objects.inv|https://frequenz-floss.github.io/frequenz-api-common/v'${ver_minor}'/objects.inv|' -i mkdocs.yml
8082
```
8183

8284
### Running tests / checks individually

0 commit comments

Comments
 (0)