You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+18-18Lines changed: 18 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Commitlint Github Action
1
+
# Commitlint GitHub Action
2
2
3
3
Lints Pull Request commits with [commitlint](https://commitlint.js.org/).
4
4
@@ -51,11 +51,11 @@ jobs:
51
51
- uses: wagoid/commitlint-github-action@v6
52
52
```
53
53
54
-
#### Important Note:
54
+
#### Important Note
55
55
56
-
To ensure that the merge_group event triggers correctly, you need to have **at least one workflow that responds to the pull_request event** with a job named the same as the one in your merge_group workflow (**commitlint** in this example). This is necessary because the merge queue relies on the existence of status checks from the pull request context.
56
+
To ensure that the `merge_group` event triggers correctly, you need to have **at least one workflow that responds to the `pull_request` event** with a job named the same as the one in your `merge_group` workflow (**commitlint** in this example). This is required because the merge queue relies on status checks from the pull request context.
57
57
58
-
Here's a minimal pull_request workflow to satisfy this requirement:
58
+
Here's a minimal `pull_request` workflow to satisfy this requirement:
59
59
60
60
```yaml
61
61
name: Placeholder Workflow for Merge Queue
@@ -92,13 +92,13 @@ You can supply these inputs to the `wagoid/commitlint-github-action@v6` step.
92
92
93
93
The path to your commitlint config file.
94
94
95
-
Default: `commitlint.config.mjs`
95
+
Default: `./commitlint.config.mjs`
96
96
97
97
If the config file doesn't exist, [config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) settings will be loaded as a default fallback.
98
98
99
99
Details on the configuration file can be found on [the commitlint website](https://commitlint.js.org/#/reference-configuration).
100
100
101
-
Note: `commitlint.config.js`doesn't work with this action. If you use a JS config file, it's required to be an ES Module (`.mjs` extension)
101
+
**Note:** `commitlint.config.js` does not work with this action. If you use a JS config file, it must use the ES Module format (`.mjs` extension).
102
102
103
103
### `failOnWarnings`
104
104
@@ -108,29 +108,29 @@ Default: `false`
108
108
109
109
### `failOnErrors`
110
110
111
-
Whether you want to fail on errors or not. Still outputs the results, just forces the action to pass even if errors are detected.
111
+
Whether to fail the action when errors are detected. When set to `false`, the action still outputs results but always passes.
112
112
113
113
Default: `true`
114
114
115
115
### `helpURL`
116
116
117
117
Link to a page explaining your commit message convention.
When set to a valid Integer value - X, considers only the latest X number of commits.
124
124
125
-
default: `null`(Equivalent to linting all commits)
125
+
Default: `null`(Equivalent to linting all commits)
126
126
127
127
### `token`
128
128
129
129
Personal access token (PAT) used to interact with the GitHub API.
130
130
By default, the automatic token provided by GitHub is used.
131
-
You can see more info about GitHub's default token [here](https://docs.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token).
131
+
You can see more info about GitHub's automatic token [here](https://docs.github.com/en/actions/tutorials/authenticate-with-github_token).
132
132
133
-
default: `${{ github.token }}`
133
+
Default: `${{ github.token }}`
134
134
135
135
## Outputs
136
136
@@ -157,28 +157,28 @@ You have commit messages with errors
157
157
ⓘ Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint
"message": "chore: my message\n\nsome context without leading blank line",
172
172
"valid": true,
173
173
"errors": [],
174
-
"warnings": ["body must have leading blank line"],
175
-
},
174
+
"warnings": ["body must have leading blank line"]
175
+
}
176
176
]
177
177
```
178
178
179
179
## About `extends` in your config file
180
180
181
-
This is a [`Docker` action](https://github.com/actions/toolkit/blob/e2adf403d6d14a9ca7474976ccaca20f72ff8209/docs/action-types.md#why-would-i-choose-a-docker-action), and was made like this so that you can run it with minimum setup, regardless of your repo's environment. It comes packed with the most famous shared configurations that you can use in your commitlint config's `extends` field:
181
+
This is a [Docker action](https://github.com/actions/toolkit/blob/e2adf403d6d14a9ca7474976ccaca20f72ff8209/docs/action-types.md#why-would-i-choose-a-docker-action), and was built this way so that you can run it with minimum setup, regardless of your repo's environment. It comes packed with the most famous shared configurations that you can use in your commitlint config's `extends` field:
Apart from the shared configurations that are included by default, you can also include extra dependencies for other configs and plugins that you want to use.
191
+
In addition to the shared configurations included by default, you can also add extra dependencies for other configs and plugins.
192
192
193
-
In order to do so, you can use `NODE_PATH` env var to make the action take those dependencies into account. Below is an example workflow that does that.
193
+
To do so, you can use the `NODE_PATH` environment variable to make the action include those dependencies. Below is an example workflow.
0 commit comments