Skip to content

docs(readme): document 'pipx' alternative installation steps #1215

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 22, 2024
Merged

docs(readme): document 'pipx' alternative installation steps #1215

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1b63866
docs(readme): fix 'pip install Commitizen' to 'commitizen'
AdrianDC Aug 18, 2024
a536d31
docs(readme): document 'pipx' alternative installation steps
AdrianDC Aug 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,18 @@ descriptive commits.

## Installation

To make commitizen available in your system
Install commitizen in your system using `pipx` (Recommended, <https://pypa.github.io/pipx/installation/>):

```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
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/gitlab_ci.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading