Skip to content

Commit d72b1c1

Browse files
committed
docs: polish readme for github actions market
1 parent 0d72277 commit d72b1c1

File tree

1 file changed

+37
-1
lines changed

1 file changed

+37
-1
lines changed

README.md

+37-1
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,36 @@
11
# commitizen-action
22

3-
Commitizen github action to bump and create changelog
3+
Add [commitizen][cz] incredibly fast into your project!
4+
5+
## Features
6+
7+
- Super easy to setup
8+
- Automatically bump version
9+
- Automatically create changelog
10+
- Update any file in your repo with the new version
11+
12+
Are you using [conventional commits][cc] and [semver][semver]?
13+
14+
Then you are ready to use this github action, the only thing you'll need is the
15+
`.cz.toml` file in your project.
416

517
## Usage
618

719
1. In your repository create a `.cz.toml` file (you can run `cz init` to create it)
820
2. Create a `.github/workflows/bumpversion.yaml` with the Sample Workflow
921

22+
### Minimal configuration
23+
24+
Your `.cz.toml` (or `pyproject.toml` if you are using python) should look like
25+
this.
26+
27+
```toml
28+
[tool.commitizen]
29+
version = "0.1.0" # This should be your current semver version
30+
```
31+
32+
For more information visit [commitizen's configuration page][cz-conf]
33+
1034
## Sample Workflow
1135

1236
```yaml
@@ -56,5 +80,17 @@ To solve it you must use a personal access token in the checkout and the commiti
5680

5781
Follow the instructions in [commitizen's documentation][cz-docs-ga]
5882

83+
## I'm not using conventional commits, I'm using my own set of rules on commits
84+
85+
If your rules can be parsed then you can build your own commitizen rules, you can
86+
create a new commitizen python package or you can describe it on the `toml` conf itself.
87+
88+
[Read more about customization][cz-custom]
89+
5990
[by_design]: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#example-using-multiple-events-with-activity-types-or-configuration
6091
[cz-docs-ga]: https://commitizen-tools.github.io/commitizen/tutorials/github_actions/
92+
[cz]: https://commitizen-tools.github.io/commitizen/
93+
[cc]: https://www.conventionalcommits.org/
94+
[semver]: https://semver.org/
95+
[cz-conf]: https://commitizen-tools.github.io/commitizen/config/
96+
[cz-custom]: https://commitizen-tools.github.io/commitizen/customization/

0 commit comments

Comments
 (0)