Skip to content

Commit 8ab19cc

Browse files
committed
Add release note about potential issues with dependencies
Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 0916b4f commit 8ab19cc

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

RELEASE_NOTES.md

+14
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,17 @@ python -m pip install frequenz-sdk
99
```
1010

1111
The GitHub issues were also improved, adding templates for [reporting issues](https://github.com/frequenz-floss/frequenz-sdk-python/issues/new?assignees=&labels=priority%3A%E2%9D%93%2C+type%3Abug&template=bug.yml) and [requesting features](https://github.com/frequenz-floss/frequenz-sdk-python/issues/new?assignees=&labels=part%3A%E2%9D%93%2C+priority%3A%E2%9D%93%2C+type%3Aenhancement&template=feature.yml). Users are also pointed to the [Discussion forums](https://github.com/frequenz-floss/frequenz-sdk-python/issues/new/choose) when trying to open an issue if they have questions instead. Also many labels are assigned automatically on issue and pull request creation.
12+
13+
## Upgrading
14+
15+
Even if there are no breaking changes, you might see this error in your local
16+
environment when upgrading:
17+
18+
ERROR: Project file:///home/luca/devel/frequenz-sdk-python has
19+
a 'pyproject.toml' and its build backend is missing the 'build_editable'
20+
hook. Since it does not have a 'setup.py' nor a 'setup.cfg', it cannot be
21+
installed in editable mode. Consider using a build backend that supports PEP
22+
660.
23+
24+
If so, you should probably update the dependencies in you virtual environment
25+
(for example `python -m pip install -U -e .`)

0 commit comments

Comments
 (0)