Skip to content

Commit

Permalink
docs: give a list of possible skip options
Browse files Browse the repository at this point in the history
  • Loading branch information
mrexox committed Oct 18, 2024
1 parent f6593b7 commit ed25f17
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -799,6 +799,13 @@ pre-commit:

You can skip all or specific commands and scripts using `skip` option. You can also skip when merging, rebasing, or being on a specific branch. Globs are available for branches.

Possible skip values:
- `rebase` - when in rebase git state
- `merge` - when in merge git state
- `merge-commit` - when current HEAD commit is the merge commit
- `ref: main` - when on a `main` branch
- `run: test ${SKIP_ME} -eq 1` - when `test ${SKIP_ME} -eq 1` is successful (return code is 0)

**Example**

Always skipping a command:
Expand Down

0 comments on commit ed25f17

Please sign in to comment.