From 1b638664c0b33b7c2bd056cc883fe190e8fcada3 Mon Sep 17 00:00:00 2001 From: Adrian DC Date: Sun, 18 Aug 2024 14:23:15 +0200 Subject: [PATCH 1/2] docs(readme): fix 'pip install Commitizen' to 'commitizen' Signed-off-by: Adrian DC --- docs/README.md | 2 +- docs/tutorials/gitlab_ci.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/README.md b/docs/README.md index b4fa13eb2..8c760be23 100644 --- a/docs/README.md +++ b/docs/README.md @@ -49,7 +49,7 @@ descriptive commits. To make commitizen available in your system ```bash -pip install --user -U Commitizen +pip install --user -U commitizen ``` ### Python project diff --git a/docs/tutorials/gitlab_ci.md b/docs/tutorials/gitlab_ci.md index de1336b67..d29bf994b 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 From a536d3147279917c882059337246e6f4e9613440 Mon Sep 17 00:00:00 2001 From: Adrian DC Date: Thu, 22 Aug 2024 02:21:37 +0200 Subject: [PATCH 2/2] docs(readme): document 'pipx' alternative installation steps Issue: #1113 --- Signed-off-by: Adrian DC --- docs/README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 8c760be23..3f729ebcb 100644 --- a/docs/README.md +++ b/docs/README.md @@ -46,7 +46,15 @@ descriptive commits. ## Installation -To make commitizen available in your system +Install commitizen in your system using `pipx` (Recommended, ): + +```bash +pipx ensurepath +pipx install commitizen +pipx upgrade commitizen +``` + +Install commitizen using `pip` with `--user` flag: ```bash pip install --user -U commitizen