Skip to content

Commit 10f4f07

Browse files
authored
Merge pull request #1 from mach-composer/feat/docs
feat: added readme
2 parents 16f205b + 76bf491 commit 10f4f07

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
11
# check-changie-changes-action
22

3-
This action checks if a new changelog file has been added in the commits
3+
This action checks if a new changelog file has been added in the commits. If not, it will fail the workflow.
4+
5+
## Usage
6+
7+
```yaml
8+
name: Check changelog changes
9+
steps:
10+
- uses: actions/checkout@v3
11+
with:
12+
fetch-depth: 0
13+
14+
- name: Has changes file
15+
# Some automated tooling might not immediately create a changelog file. These can be handled independently
16+
if: github.actor != 'dependabot[bot]'
17+
uses: mach-composer/check-changie-changes-action@v0.1.0
18+
```
19+

0 commit comments

Comments
 (0)