Skip to content

Readme is not up to data also commit-check is invoked with wrong params but action doesn't fail #14

Closed
@mkocztorz

Description

@mkocztorz

describe your issue
I had to add requirements.txt in my repo, but there is no mention of it in the readme.

commit-check doesn't accept given params. The action doesn't fail even if no check was really done.

This error is here since moving to 5.*, even on this repo:
image

commit-check version
commit-check 5.3.0

.commit-check.yml
checks:

  • check: message
    regex: '^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test){1}(([\w-.]+))?(!)?: ([\w ])+([\s\S])|(Merge).|(fixup!.*)'
    error: "The commit message should be structured as follows:\n\n
    [optional scope]: \n
    [optional body]\n
    [optional footer(s)]\n\n
    More details please refer to https://www.conventionalcommits.org"
    suggest: please check your commit message whether matches above regex
  • check: branch
    regex: ^(TRK-)/[0-9]]+-[0-9]]+|(master)|(main)|(dev)|(HEAD)
    error: "Branches must begin with JIRA task ID"
    suggest: run command git checkout -b type/branch_name
  • check: author_name
    regex: ^[A-Za-z ,.'-]+$|.*([bot])
    error: The committer name seems invalid
    suggest: run command git config user.name "Your Name"
  • check: author_email
    regex: ^\S+@\S+.\S+$
    error: The committer email seems invalid
    suggest: run command git config user.email yourname@example.com

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions