Skip to content

Commit b9cc626

Browse files
committed
Add release notes
Include a command-line to fix the files inplace without having to re-generate the files from the templates. Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 9e226e5 commit b9cc626

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

RELEASE_NOTES.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,12 @@ To upgrade without regenerating the project, you can follow these steps:
5454
5555
This will update the file in place, you can inspect the changes with `git diff`.
5656
57+
- For API projects, you can manually add instructions to update the `mkdocs.yml` when the `frequenz-api-common` dependency is updated.
58+
59+
```sh
60+
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
61+
```
62+
5763
## New Features
5864
5965
<!-- 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:
6369
- Some checks that are already performed by `flake8` are now disabled in `pylint` to avoid double reporting.
6470
- The repository ruleset `Protect version branches` has been updated to allow repository maintainers to skip protection rules in PRs.
6571
- The `labeler` action was upgraded to 5.0.0, which allows for more complex matching rules.
72+
- Instruction were added to update the `mkdocs.yml` when the `frequenz-api-common` dependency is updated.
6673
6774
## Bug Fixes
6875

0 commit comments

Comments
 (0)