Add missing instruction to update dependencies (#223)

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.

Author: llucax

RELEASE_NOTES.md

@@ -15,7 +15,7 @@ To upgrade without regenerating the project, you can follow these steps:
 - Run the following command to add the new `pylint` ignore rules:
 
     ```sh
-    sed '/  # Checked by flake8/a\  "redefined-outer-name",\n  "unused-import",' pyproject.toml
+    sed '/  # Checked by flake8/a\  "redefined-outer-name",\n  "unused-import",' -i pyproject.toml
     ```
 
 - It is recommended to update this rule in your repository to use the new bypass rule for the `Protect version branches` ruleset that allows maintainers to force-merge.
@@ -54,6 +54,12 @@ To upgrade without regenerating the project, you can follow these steps:
 
     This will update the file in place, you can inspect the changes with `git diff`.
 
+- For API projects, you can manually add instructions to update the `mkdocs.yml` when the `frequenz-api-common` dependency is updated.
+
+    ```sh
+    awk -i inplace '/^sed s..frequenz-api-common/ { print; print "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"; next }1' CONTRIBUTING.md
+    ```
+
 ## New Features
 
 <!-- Here goes the main new features and examples or instructions on how to use them -->
@@ -63,6 +69,7 @@ To upgrade without regenerating the project, you can follow these steps:
 - Some checks that are already performed by `flake8` are now disabled in `pylint` to avoid double reporting.
 - The repository ruleset `Protect version branches` has been updated to allow repository maintainers to skip protection rules in PRs.
 - The `labeler` action was upgraded to 5.0.0, which allows for more complex matching rules.
+- Instruction were added to update the `mkdocs.yml` when the `frequenz-api-common` dependency is updated.
 
 ## Bug Fixes
 

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

@@ -75,13 +75,15 @@ Here is an example of upgrading the `frequenz-api-common` dependency to version
 `v0.2.0`:
 ```sh
 ver="0.2.0"
+ver_minor=$(echo $ver | cut -d. -f1,2)
 
 cd submodules/frequenz-api-common
 git remote update
 git checkout v${ver}
 cd -
 
-sed s/"frequenz-api-common == [0-9]\.[0-9]\.[0-9]"/"frequenz-api-common == ${ver}"/g -i pyproject.toml
+sed 's/frequenz-api-common == [0-9]\.[0-9]\.[0-9]/frequenz-api-common == '"${ver}/" -i pyproject.toml
+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
 ```
 {%- endif %}
 

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

@@ -70,13 +70,15 @@ Here is an example of upgrading the `frequenz-api-common` dependency to version
 `v0.2.0`:
 ```sh
 ver="0.2.0"
+ver_minor=$(echo $ver | cut -d. -f1,2)
 
 cd submodules/frequenz-api-common
 git remote update
 git checkout v${ver}
 cd -
 
-sed s/"frequenz-api-common == [0-9]\.[0-9]\.[0-9]"/"frequenz-api-common == ${ver}"/g -i pyproject.toml
+sed 's/frequenz-api-common == [0-9]\.[0-9]\.[0-9]/frequenz-api-common == '"${ver}/" -i pyproject.toml
+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
 ```
 
 ### Running tests / checks individually