Skip to content

Commit dc35c91

Browse files
committed
Update readme with new config feature
1 parent bf5ef80 commit dc35c91

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,15 +74,19 @@ packages/documentation/copy/es/**/*.ts @KingDarBoja [translate] [es]
7474

7575
## Config
7676

77-
There is only one option available ATM, `cwd` which can be used to determine the root folder to look for CODEOWNER files in:
77+
There are only two options available at the moment:
78+
79+
- `cwd`, which can be used to determine the root folder to look for CODEOWNER files in.
80+
- `merge_method`, which can be `merge` (default), `squash` or `rebase`, depending on what you want the action to do.
7881

7982
```yml
8083
- name: Run Codeowners merge check
8184
uses: OSS-Docs-Tools/code-owner-self-merge@v1
8285
env:
8386
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
84-
with:
87+
with:
8588
cwd: './docs'
89+
merge_method: 'squash'
8690
```
8791

8892
### Dev

0 commit comments

Comments
 (0)