Skip to content

Commit d4b5d5c

Browse files
committed
refactor: Rename tool and change repositories
1 parent 7ab2711 commit d4b5d5c

11 files changed

+519
-524
lines changed

.github/FUNDING.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# These are supported funding model platforms
22

3-
open_collective: commitizen-tools
4-
github: commitizen-tools
3+
open_collective: czplus-tools
4+
github: czplus-tools

.github/workflows/bumpversion.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ jobs:
2222
token: ${{ secrets.PERSONAL_ACCESS_TOKEN_FOR_ORG }}
2323
file: 'docs/README.md'
2424
- name: Create bump and changelog
25-
uses: commitizen-tools/commitizen-action@master
25+
uses: czplus-tools/commitizen-plus-action@master
2626
with:
2727
github_token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
2828
changelog_increment_filename: body.md

.pre-commit-config.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ repos:
4545
args: [ "--write-changes", "--ignore-words-list", "asend" ]
4646
exclude: "poetry.lock"
4747

48-
- repo: https://github.com/commitizen-tools/commitizen
48+
- repo: https://github.com/czplus-tools/commitizen-plus
4949
rev: v0.1.0 # automatically updated by Commitizen
5050
hooks:
5151
- id: commitizen

commitizen/cli.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ def __call__(
101101
"name": ["-nr", "--no-raise"],
102102
"type": str,
103103
"required": False,
104-
"help": "comma separated error codes that won't rise error, e.g: cz -nr 1,2,3 bump. See codes at https://commitizen-tools.github.io/commitizen/exit_codes/",
104+
"help": "comma separated error codes that won't rise error, e.g: cz -nr 1,2,3 bump. See codes at https://czplus-tools.github.io/commitizen-plus/exit_codes/",
105105
},
106106
],
107107
"subcommands": {

commitizen/commands/init.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -81,12 +81,12 @@ def __call__(self):
8181
out.line(f"Config file {self.config.path} already exists")
8282
return
8383

84-
out.info("Welcome to commitizen!\n")
84+
out.info("Welcome to commitizen-plus!\n")
8585
out.line(
8686
"Answer the questions to configure your project.\n"
8787
"For further configuration visit:\n"
8888
"\n"
89-
"https://commitizen-tools.github.io/commitizen/config/"
89+
"https://czplus-tools.github.io/commitizen-plus/config/"
9090
"\n"
9191
)
9292

@@ -312,7 +312,7 @@ def _gen_pre_commit_cmd(self, hook_types: list[str]) -> str:
312312
def _install_pre_commit_hook(self, hook_types: list[str] | None = None):
313313
pre_commit_config_filename = ".pre-commit-config.yaml"
314314
cz_hook_config = {
315-
"repo": "https://github.com/commitizen-tools/commitizen",
315+
"repo": "https://github.com/czplus-tools/commitizen-plus",
316316
"rev": f"v{__version__}",
317317
"hooks": [
318318
{"id": "commitizen"},

docs/README.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/commitizen-tools/commitizen/pythonpackage.yml?label=python%20package&logo=github&logoColor=white&style=flat-square)](https://github.com/commitizen-tools/commitizen/actions)
1+
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/commitizen-tools/commitizen/pythonpackage.yml?label=python%20package&logo=github&logoColor=white&style=flat-square)](https://github.com/commitizen-tools/commitizen/actions) # TODO: Update badges
22
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat-square)](https://conventionalcommits.org)
33
[![PyPI Package latest release](https://img.shields.io/pypi/v/commitizen.svg?style=flat-square)](https://pypi.org/project/commitizen/)
44
[![PyPI Package download count (per month)](https://img.shields.io/pypi/dm/commitizen?style=flat-square)](https://pypi.org/project/commitizen/)
@@ -11,7 +11,7 @@
1111

1212
---
1313

14-
**Documentation:** [https://commitizen-tools.github.io/commitizen/](https://commitizen-tools.github.io/commitizen/)
14+
**Documentation:** [https://czplus-tools.github.io/commitizen-plus/](https://czplus-tools.github.io/commitizen-plus/)
1515

1616
---
1717

@@ -85,22 +85,22 @@ brew install commitizen
8585
Most of the time this is the only command you'll run:
8686

8787
```sh
88-
cz bump
88+
czp bump
8989
```
9090

9191
On top of that, you can use commitizen to assist you with the creation of commits:
9292

9393
```sh
94-
cz commit
94+
czp commit
9595
```
9696

9797
Read more in the section [Getting Started](./getting_started.md).
9898

9999
### Help
100100

101101
```sh
102-
$ cz --help
103-
usage: cz [-h] [--debug] [-n NAME] [-nr NO_RAISE] {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version} ...
102+
$ czp --help
103+
usage: czp [-h] [--debug] [-n NAME] [-nr NO_RAISE] {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version} ...
104104

105105
Commitizen is a cli tool to generate conventional commits.
106106
For more information about the topic go to https://conventionalcommits.org/
@@ -110,7 +110,7 @@ optional arguments:
110110
--debug use debug mode
111111
-n NAME, --name NAME use the given commitizen (default: cz_conventional_commits)
112112
-nr NO_RAISE, --no-raise NO_RAISE
113-
comma separated error codes that won't rise error, e.g: cz -nr 1,2,3 bump. See codes at https://commitizen-
113+
comma separated error codes that won't rise error, e.g: czp -nr 1,2,3 bump. See codes at https://commitizen-
114114
tools.github.io/commitizen/exit_codes/
115115
116116
commands:
@@ -119,7 +119,7 @@ commands:
119119
commit (c) create new commit
120120
ls show available commitizens
121121
example show commit example
122-
info show information about the cz
122+
info show information about the czp
123123
schema show commit schema
124124
bump bump semantic version based on the git log
125125
changelog (ch) generate changelog (note that it will overwrite existing file)
@@ -142,13 +142,13 @@ sudo activate-global-python-argcomplete
142142
For permanent (but not global) Commitizen activation, use:
143143

144144
```bash
145-
register-python-argcomplete cz >> ~/.bashrc
145+
register-python-argcomplete czp >> ~/.bashrc
146146
```
147147

148148
For one-time activation of argcomplete for Commitizen only, use:
149149

150150
```bash
151-
eval "$(register-python-argcomplete cz)"
151+
eval "$(register-python-argcomplete czp)"
152152
```
153153

154154
For further information on activation, please visit the [argcomplete website](https://kislyuk.github.io/argcomplete/).

docs/contributing.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
First of all, thank you for taking the time to contribute! 🎉
44

5-
When contributing to [commitizen](https://github.com/commitizen-tools/commitizen), please first create an [issue](https://github.com/commitizen-tools/commitizen/issues) to discuss the change you wish to make before making a change.
5+
When contributing to [commitizen](https://github.com/czplus-tools/commitizen-plus), please first create an [issue](https://github.com/czplus-tools/commitizen-plus/issues) to discuss the change you wish to make before making a change.
66

7-
If you're a first-time contributor, you can check the issues with [good first issue](https://github.com/commitizen-tools/commitizen/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tag.
7+
If you're a first-time contributor, you can check the issues with [good first issue](https://github.com/commitizen-tools/commitizen/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tag. # Todo: Check good issue
88

99
## Install before contributing
1010

@@ -13,20 +13,20 @@ If you're a first-time contributor, you can check the issues with [good first is
1313

1414
## Before making a pull request
1515

16-
1. Fork [the repository](https://github.com/commitizen-tools/commitizen).
16+
1. Fork [the repository](https://github.com/czplus-tools/commitizen-plus).
1717
2. Clone the repository from your GitHub.
1818
3. Setup development environment through [poetry](https://python-poetry.org/) (`poetry install`).
1919
4. Setup [pre-commit](https://pre-commit.com/) hook (`poetry run pre-commit install`)
2020
5. Check out a new branch and add your modification.
2121
6. Add test cases for all your changes.
2222
(We use [CodeCov](https://codecov.io/) to ensure our test coverage does not drop.)
23-
7. Use [commitizen](https://github.com/commitizen-tools/commitizen) to do git commit. We follow [conventional commits](https://www.conventionalcommits.org/).
23+
7. Use [commitizen-plus](https://github.com/czplus-tools/commitizen-plus) to do git commit. We follow [conventional commits](https://www.conventionalcommits.org/).
2424
8. Run `./scripts/format` and `./scripts/test` to ensure you follow the coding style and the tests pass.
2525
9. Optionally, update the `./docs/README.md`.
26-
9. **Do not** update the `CHANGELOG.md`, it will be automatically created after merging to `master`.
27-
10. **Do not** update the versions in the project, they will be automatically updated.
28-
10. If your changes are about documentation. Run `poetry run mkdocs serve` to serve documentation locally and check whether there is any warning or error.
29-
11. Send a [pull request](https://github.com/commitizen-tools/commitizen/pulls) 🙏
26+
10. **Do not** update the `CHANGELOG.md`, it will be automatically created after merging to `master`.
27+
11. **Do not** update the versions in the project, they will be automatically updated.
28+
12. If your changes are about documentation. Run `poetry run mkdocs serve` to serve documentation locally and check whether there is any warning or error.
29+
13. Send a [pull request](https://github.com/czplus-tools/commitizen-plus/pulls) 🙏
3030

3131
## Use of GitHub Labels
3232

docs/customization.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ commitizen:
164164
| `change_type_map` | `dict` | `None` | (OPTIONAL) Dictionary mapping the type of the commit to a changelog entry |
165165

166166
[jinja2]: https://jinja.palletsprojects.com/en/2.10.x/
167-
[changelog-spec]: https://commitizen-tools.github.io/commitizen/changelog/
167+
[changelog-spec]: https://czplus-tools.github.io/commitizen-plus/changelog/
168168

169169
#### Detailed `questions` content
170170

@@ -197,6 +197,7 @@ Check an [example](convcomms) on how to configure `BaseCommitizen`.
197197

198198
You can also automate the steps above through [cookiecutter](https://cookiecutter.readthedocs.io/en/1.7.0/).
199199

200+
# TODO
200201
```sh
201202
cookiecutter gh:commitizen-tools/commitizen_cz_template
202203
```

mkdocs.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ theme:
2525
icon: material/brightness-4
2626
name: Switch to system preference
2727

28-
repo_name: commitizen-tools/commitizen
29-
repo_url: https://github.com/commitizen-tools/commitizen
28+
repo_name: czplus-tools/commitizen-plus
29+
repo_url: https://github.com/czplus-tools/commitizen-plus
3030
edit_uri: ""
3131

3232
nav:

0 commit comments

Comments
 (0)