Skip to content

Commit f8061b4

Browse files
committed
docs: update readme.md
1 parent 1ab8377 commit f8061b4

File tree

1 file changed

+25
-16
lines changed

1 file changed

+25
-16
lines changed

README.md

Lines changed: 25 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,15 @@
88

99
A Github Action for checking commit message formatting, branch naming, committer name, email, commit signoff and more.
1010

11+
## Table of Contents
12+
13+
* [Usage](#usage)
14+
* [Optional Inputs](#optional-inputs)
15+
* [GitHub Action Job Summary](#github-action-job-summary)
16+
* [GitHub Pull Request Comments](#github-pull-request-comments)
17+
* [Badging Your Repository](#badging-your-repository)
18+
* [Versioning](#versioning)
19+
1120
## Usage
1221

1322
Create a new GitHub Actions workflow in your project, e.g. at [.github/workflows/commit-check.yml](.github/workflows/commit-check.yml)
@@ -51,33 +60,33 @@ jobs:
5160

5261
- **Description**: check commit message formatting convention.
5362
- By default the rule follows [conventional commits](https://www.conventionalcommits.org/).
54-
- Default: 'true'
63+
- Default: `true`
5564

5665
### `branch`
5766

5867
- **Description**: check git branch naming convention.
5968
- By default follow bitbucket [conventional branch](https://conventional-branch.github.io/).
60-
- Default: 'true'
69+
- Default: `true`
6170

6271
### `author-name`
6372

6473
- **Description**: check committer author name.
65-
- Default: 'true'
74+
- Default: `true`
6675

6776
### `author-email`
6877

6978
- **Description**: check committer author email.
70-
- Default: 'true'
79+
- Default: `true`
7180

7281
### `commit-signoff`
7382

7483
- **Description**: check committer commit signature.
75-
- Default: 'true'
84+
- Default: `true`
7685

7786
### `merge-base`
7887

7988
- **Description**: check current branch is rebased onto target branch.
80-
- Default: 'false'
89+
- Default: `false`
8190

8291
> [!IMPORTANT]
8392
> `merge-base` is an experimental feature. by default it's disable.
@@ -87,17 +96,17 @@ jobs:
8796
### `dry-run`
8897

8998
- **Description**: run checks without failing. exit code is 0 otherwise is 1.
90-
- Default: 'false'
99+
- Default: `false`
91100

92101
### `job-summary`
93102

94103
- **Description**: display job summary to the workflow run.
95-
- Default: 'true'
104+
- Default: `true`
96105

97106
### `pr-comments`
98107

99108
- **Description**: post results to the pull request comments.
100-
- Default: 'false'
109+
- Default: `false`
101110

102111
> [!IMPORTANT]
103112
> `pr-comments` is an experimental feature. by default it's disable. To use it you need to set `GITHUB_TOKEN` in the GitHub Action.
@@ -106,29 +115,29 @@ jobs:
106115

107116
Note: the default rule of above inputs is following [this configuration](https://github.com/commit-check/commit-check/blob/main/.commit-check.yml), if you want to customize just add your `.commit-check.yml` config file under your repository root directory.
108117

109-
## GitHub Action job summary
118+
## GitHub Action Job Summary
110119

111120
By default, commit-check-action results are shown on the job summary page of the workflow.
112121

113-
### Success job summary
122+
### Success Job Summary
114123

115124
![Success job summary](https://github.com/commit-check/.github/blob/main/screenshot/success-job-summary.png)
116125

117-
### Failure job summary
126+
### Failure Job Summary
118127

119128
![Failure job summary](https://github.com/commit-check/.github/blob/main/screenshot/failure-job-summary.png)
120129

121-
## GitHub Pull Request comments
130+
## GitHub Pull Request Comments
122131

123-
### Success pull request comment
132+
### Success Pull Request Comment
124133

125134
![Success pull request comment](https://github.com/commit-check/.github/blob/main/screenshot/success-pr-comments.png)
126135

127-
### Failure pull request comment
136+
### Failure Pull Request Comment
128137

129138
![Failure pull request comment](https://github.com/commit-check/.github/blob/main/screenshot/failure-pr-comments.png)
130139

131-
## Badging your repository
140+
## Badging Your Repository
132141

133142
You can add a badge to your repository to show your contributors/users that you use commit-check!
134143

0 commit comments

Comments
 (0)