Skip to content
This repository was archived by the owner on Apr 21, 2020. It is now read-only.

Commit 661a398

Browse files
committed
Docs: Update main Readme file
1 parent 252a43f commit 661a398

File tree

1 file changed

+9
-21
lines changed

1 file changed

+9
-21
lines changed

README.md

Lines changed: 9 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,27 +6,15 @@ Its a part of the Docker Command series
66

77
## Usage
88

9-
Execute the following within your repository folder:
10-
11-
- Using Bash:
12-
- `./entrypoint.sh [git-repository-dir]`
13-
- `./entrypoint.sh "Commit message"`
14-
- `echo "Commit message" | ./entrypoint.sh -`
15-
- Using Docker:
16-
- `docker run --rm -v [git-repository-dir]:/workspace kairops/dc-commit-validator .`
17-
- `docker run --rm kairops/dc-commit-validator "Commit message"`
18-
- `echo "Commit message" | docker run --rm kairops/dc-commit-validator -`
19-
- Using docker-command-launcher:
20-
- `kd git-changelog-generator [git-repository-dir]`
21-
- `kd git-changelog-generator "Commit message"`
22-
- `echo "Commit message" | kd git-changelog-generator -`
23-
24-
The script will check if the message(s) of the unreleased commit(s) (or the commit message passed as parameter) fulfill the rules of [Git Changelog Generator](https://github.com/kairops/dc-git-changelog-generator)
25-
26-
- If you pass a existent directory of the filesystem in the first parameter, the script expect to find a git repository and will check all the messages of all unreleased commit.
27-
- If you pass a commit message as a text, the script will check it.
28-
29-
In both cases, it will return 0 if the message (or messages) fulfill the rules, and 1 in other case.
9+
Execute the following:
10+
11+
- Using Bash, withinh your repository folder: `cd [git-repository-dir]; [/path/to/commit-validator]/entrypoint.sh`
12+
- Using Docker: `docker run --rm -v [git-repository-dir]:/workspace kairops/dc-commit-validator .`
13+
- Using docker-command-launcher:`kd git-changelog-generator [git-repository-dir]`
14+
15+
The script will check if the commit message(s) of your repository corresponding to the unreleased commit(s) fulfill the rules of [Git Changelog Generator](https://github.com/kairops/dc-git-changelog-generator)
16+
17+
It will return 0 if the the whole commit messages fulfill the rules, and 1 if at least one commit does not.
3018

3119
## Considerations
3220

0 commit comments

Comments
 (0)