Skip to content

Commit 68e65da

Browse files
committed
docs: add github actions section
1 parent 6838c63 commit 68e65da

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

+6
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
- [Configuration](#configuration)
99
- [Usage](#usage)
1010
- [Markdown](#markdown)
11+
- [Github Actions](#github-actions)
1112
- [Library](#library)
1213

1314
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -155,6 +156,11 @@ you get the following markdown:
155156

156157
An example can be found [here](./CHANGELOG.md).
157158

159+
### Github Actions
160+
161+
Here is an example how you can use the `changlog` tool to verify conventional commits in a github action: [conventional-commits.yml](.github/workflows/conventional-commits.yml)
162+
163+
158164
## Library
159165
Instead of regular expressions, this package uses a lexer, that functions similarly to Rob Pike's discussion about lexer
160166
design in this [talk](https://www.youtube.com/watch?v=HxaD_trXwRE).

0 commit comments

Comments
 (0)