Skip to content

Commit 286a484

Browse files
authored
Clarify that upgrading notes should be read before updating (#103)
This should improve the situation reported in #99.
2 parents 218fb08 + 40bc1f3 commit 286a484

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

docs/index.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -226,8 +226,13 @@ without having to enter all the inputs again.
226226

227227
!!! warning
228228

229-
Don't forget to commit all changes in your repository before doing this!
230-
Files will be overwritten!
229+
* Don't forget to commit all changes in your repository before doing this!
230+
Files will be overwritten!
231+
* Don't forget to check all the [release
232+
notes](https://github.com/frequenz-floss/frequenz-repo-config-python/releases)
233+
for all the versions you are going to update, in particular the
234+
**Upgrading** section, as there might be steps necessary before even
235+
running the `cookiecutter` command for the update.
231236

232237
```sh
233238
git commit -a # commit all changes

0 commit comments

Comments
 (0)