Skip to content

Commit 4a258f6

Browse files
authored
Update README.md
1 parent 239e40a commit 4a258f6

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -137,18 +137,18 @@ The hook can be created either manually or using the [pre-commit framework](http
137137
# fix for windows systems
138138
PATH="/c/Program Files/nodejs:$HOME/AppData/Roaming/npm/:$PATH"
139139
140-
git-conventional-commits commit-msg-hook "$1"
140+
npx git-conventional-commits commit-msg-hook "$1"
141141
```
142142
* Add and commit `.git-hooks/commit-msg` to repository
143143
* ⚠️ Whenever you clone your repository with git hooks you need to enable git hooks once again
144144
* `git config core.hooksPath .git-hooks`
145145

146146

147147
### Release Workflow with `git-conventional-commits`
148-
* Determine version by `git-conventional-commits version`
148+
* Determine version by `npx git-conventional-commits version`
149149
* Update version in project files
150150
* Commit version bump `git commit -am'build(release): bump project version to <version>'`
151-
* Generate change log by `git-conventional-commits changelog --release <version> --file 'CHANGELOG.md'`
151+
* Generate change log by `npx git-conventional-commits changelog --release <version> --file 'CHANGELOG.md'`
152152
* Commit change log `git commit -am'docs(release): create <version> change log entry'`
153153
* Tag commit with version `git tag -a -m'build(release): <version>' '<version-prefix><version>'`
154154
* Push all changes `git push`
@@ -159,7 +159,7 @@ The hook can be created either manually or using the [pre-commit framework](http
159159
If you have an large existing repo with no release tags e.g. v1.0.0, or if you want the first changelog to be tidy, you need to create a release tag first.
160160
* Create release tag for specific commit`git tag -a -m'build(release): 0.0.0' 'v0.0.0'`
161161
* Push tag `git push origin v0.0.0`
162-
This way `git-conventional-commits` will use that the taged commit as the point in time to start looking for commits.
162+
This way `npx git-conventional-commits` will only considre commits based on the commit the release tag is pointing at.
163163

164164
---
165165

0 commit comments

Comments
 (0)