Skip to content

Commit 7f867d5

Browse files
committed
docs(README): add better usage instructions
1 parent 88c974e commit 7f867d5

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Commitizen github action to bump and create changelog
44

55
## Usage
66

7-
1. In your local repo remember to create a `.cz.toml` file (run `cz init` to create it)
7+
1. In your repository create a `.cz.toml` file (you can run `cz init` to create it)
88
2. Create a `.github/workflows/bumpversion.yaml` with the Sample Workflow
99

1010
## Sample Workflow
@@ -43,6 +43,11 @@ jobs:
4343

4444
<!-- | `changelog` | Create changelog when bumping the version | true | -->
4545

46+
If you use `secrets.GITHUB_TOKEN` other actions won't be triggered.
47+
To solve that you will need a personal access token.
48+
Follow the instructions of [github tutorial](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token#creating-a-token) in order
49+
to create one
50+
4651
## Contributing
4752

4853
Whenever we want to release a new version, we have to mark it as breaking change.

0 commit comments

Comments
 (0)