Skip to content

[FEATURE] Skip merge commits in pull requests #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ More information about `pattern` and `flags` can be found in the

`flags` is optional and defaults to `gm`.

`excludeDescription`, `excludeTitle` and `checkAllCommitMessages` are optional.
Default behavior is to include the description and title and not check pull
request commit messages.
`excludeDescription`, `excludeTitle`, `excludeMergeCommits`, and
`checkAllCommitMessages` are optional. Default behavior is to include the
description, title, and merge commits, and not check pull request commit messages.

### Example Workflow

Expand Down Expand Up @@ -67,8 +67,9 @@ jobs:
error: 'The maximum line length of 74 characters is exceeded.'
excludeDescription: 'true' # optional: this excludes the description body of a pull request
excludeTitle: 'true' # optional: this excludes the title of a pull request
excludeMergeCommits: 'true' # optional: this excludes merge commits
checkAllCommitMessages: 'true' # optional: this checks all commits associated with a pull request
accessToken: ${{ secrets.GITHUB_TOKEN }} # github access token is only required if checkAllCommitMessages is true
accessToken: ${{ secrets.GITHUB_TOKEN }} # github access token is only required if checkAllCommitMessages or excludeMergeCommits is true
- name: Check for Resolves / Fixes
uses: gsactions/commit-message-checker@v2
with:
Expand Down
2 changes: 1 addition & 1 deletion __tests__/commit-message-checker.test.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* This file is part of the "GS Commit Message Checker" Action for Github.
*
* Copyright (C) 2019 by Gilbertsoft LLC (gilbertsoft.org)
* Copyright (C) 2019-2022 by Gilbertsoft LLC (gilbertsoft.org)
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
Expand Down
Loading