Skip to content

Commit

Permalink
Apply reviewers recomendations
Browse files Browse the repository at this point in the history
  • Loading branch information
taurus-forever committed Apr 11, 2024
1 parent 0c425a6 commit e83f1e5
Showing 1 changed file with 7 additions and 9 deletions.
16 changes: 7 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,16 +41,18 @@ tox # runs 'lint' and 'unit' environments
## Build charm

The build environment assumes that there are preinstalled on the system:
* [tox](https://tox.wiki/)
* [tox](https://tox.wiki/) (version 4+ !!!)
* [poetry](https://python-poetry.org/)
* [charmcraft](https://snapcraft.io/charmcraft)
* [charmcraftcache](https://pypi.org/project/charmcraftcache/)
* [pipx](https://python.land/virtual-environments/pipx)
* [libpq-dev](https://pypi.org/project/libpq-dev/)
* [libpq-dev](https://www.postgresql.org/docs/current/libpq.html)

To build the charm it is also necessary at least 5GB if free disk space and
it is recommended to provide 4+ CPU cores and 8GB+ RAM for a decent build speed.



To install all above build dependencies (assuming you are on Ubuntu 22.04 LTS):

```shell
Expand All @@ -61,6 +63,9 @@ lxd init --auto # init LXD (if never used earlier)

sudo apt update && sudo apt install --yes libpq-dev pipx

sudo apt purge tox # if old tox version is installed from apt

pipx install tox
pipx install poetry
pipx install charmcraftcache
pipx ensurepath
Expand All @@ -71,13 +76,6 @@ Ensure local pip binaries are in your $PATH (otherwise re-login to your shell):
charmcraftcache --help
```

Make sure the install tox version is 4+ (using `tox --version`), if missing OR
the previos version installed as debian package (topical for Ubuntu 22.04 LTS):
purge it and install from pip:
```shell
sudo apt purge tox && pipx install tox && tox --version
```

Build the charm (inside this Git repository):

```shell
Expand Down

0 comments on commit e83f1e5

Please sign in to comment.