diff --git a/docs/README.md b/docs/README.md index b4fa13eb2c..3f729ebcbc 100644 --- a/docs/README.md +++ b/docs/README.md @@ -46,10 +46,18 @@ descriptive commits. ## Installation -To make commitizen available in your system +Install commitizen in your system using `pipx` (Recommended, ): ```bash -pip install --user -U Commitizen +pipx ensurepath +pipx install commitizen +pipx upgrade commitizen +``` + +Install commitizen using `pip` with `--user` flag: + +```bash +pip install --user -U commitizen ``` ### Python project diff --git a/docs/tutorials/gitlab_ci.md b/docs/tutorials/gitlab_ci.md index de1336b675..d29bf994bd 100644 --- a/docs/tutorials/gitlab_ci.md +++ b/docs/tutorials/gitlab_ci.md @@ -79,7 +79,7 @@ auto-bump: - "which ssh-agent || ( apt-get update -qy && apt-get install openssh-client -qqy )" - eval `ssh-agent -s` - echo "${SSH_PRIVATE_KEY}" | tr -d '\r' | ssh-add - > /dev/null # add ssh key - - pip3 install -U Commitizen # install commitizen + - pip3 install -U commitizen # install commitizen - mkdir -p ~/.ssh - chmod 700 ~/.ssh - echo "$SSH_PUBLIC_KEY" >> ~/.ssh/id_rsa.pub