Using commits instead of PR title

[root-ansh-ct]

Code of Conduct

• I agree to follow this project's Code of Conduct

Is there an existing issue for this?

• I have searched the existing issues

GitHub-hosted runner

ubuntu-latest

Additional runner information

      - name: validate commit format -- Check if HEAD commit message contains [xyz] or FAIL.
        uses: gsactions/commit-message-checker@v1
        with:
          pattern: '\[[^]]+\]'
          flags: 'gm'
          error: 'Your  commit must contain `[..]` like "[BUGFIX] or [SDK-974]".'
          #checkAllCommitMessages: 'false' # optional: this checks all commits associated with a pull request
          #accessToken: ${{ secrets.GITHUB_TOKEN }} # github access token is only required if checkAllCommitMessages is true

          #pattern: '^[^#].{74}'     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
          #pattern: '^.+(Resolves|Fixes): \#[0-9]+$' #  Check for Resolves / Fixes

Current Behavior

The above mentioned yaml is not working on head commit but rather the PR title. i wish to check on just the head commit and not enforce namings on PR title/ description

Expected Behavior

expected the regex '\[[^]]+\]' to match for commit [FIX] [SDK-974] validate head commit format (should be successful) , but not sure why it isn't matching . on regex101 site, it seems to work correctly. : https://regex101.com/r/VapGyU/1

Steps To Reproduce

run the above yaml mentioned in any github runner and you will find the title getting validated but not the head commit

Anything else?

https://github.com/CleverTap/clevertap-android-sdk/actions/runs/2014762191

[gilbertsoft]

Hey @root-ansh-ct

As long as you don't set checkAllCommitMessages to true only the PR tile and description are used as written here https://github.com/GsActions/commit-message-checker#configuration.

And also check how to debug the action here https://github.com/GsActions/commit-message-checker#troubleshooting-and-debugging.

[root-ansh-ct]

@gilbertsoft i am unable to open this link or any link from https://regexr.com . maybe its some DNS issue for Indian users . can you try sharing screenshots here or replicate your example on https://regex101.com/ ?

[gilbertsoft]

[gilbertsoft]

https://regex101.com/r/x0room/1

[root-ansh-ct]

@gilbertsoft thanks for the clarification. but as you see this does not check just the head commit but rather all the commits. so there can be a situation where the head commit is incorrect but one of the previous commits might get matched. i want to ensure that the latest commit only triggers the later workflow and not any commit.

in this image here, the head commit is improperly formatted but one of the previous commit is correctly formatted . but i think the action will treat this as successfully passing. ideally it should fail the workflow run

[gilbertsoft]

You have to remove the multiline flag for that case. I've updated my example https://regex101.com/r/x0room/4

[root-ansh]

hey @gilbertsoft , I think am very close to getting this to work. I checked the regex, this seems to pickup the first message correctly. however when running in the github action, it seems to give error, not sure why. I even enabled logging and here are the logs:

2022-03-22T09:26:59.2416093Z ##[debug]Evaluating condition for step: 'validate commit format -- Check if HEAD commit message contains [xyz] or FAIL'
2022-03-22T09:26:59.2420233Z ##[debug]Evaluating: success()
2022-03-22T09:26:59.2420804Z ##[debug]Evaluating success:
2022-03-22T09:26:59.2421565Z ##[debug]=> true
2022-03-22T09:26:59.2422228Z ##[debug]Result: true
2022-03-22T09:26:59.2424012Z ##[debug]Starting: validate commit format -- Check if HEAD commit message contains [xyz] or FAIL
2022-03-22T09:26:59.2457298Z ##[debug]Loading inputs
2022-03-22T09:26:59.2500171Z ##[debug]Evaluating: secrets.GITHUB_TOKEN
2022-03-22T09:26:59.2500602Z ##[debug]Evaluating Index:
2022-03-22T09:26:59.2500950Z ##[debug]..Evaluating secrets:
2022-03-22T09:26:59.2501330Z ##[debug]..=> Object
2022-03-22T09:26:59.2501674Z ##[debug]..Evaluating String:
2022-03-22T09:26:59.2502326Z ##[debug]..=> 'GITHUB_TOKEN'
2022-03-22T09:26:59.2503540Z ##[debug]=> '***'
2022-03-22T09:26:59.2504052Z ##[debug]Result: '***'
2022-03-22T09:26:59.2516898Z ##[debug]Loading env
2022-03-22T09:26:59.2524613Z ##[group]Run gsactions/commit-message-checker@v1
2022-03-22T09:26:59.2525098Z with:
2022-03-22T09:26:59.2525360Z   excludeDescription: true
2022-03-22T09:26:59.2525636Z   excludeTitle: true
2022-03-22T09:26:59.2526029Z   pattern: ^\[[^]]+\].+
2022-03-22T09:26:59.2526449Z   flags: g
2022-03-22T09:26:59.2526767Z   error: Your head commit must contain `[..]` like "[BUGFIX] or [SDK-974]".
2022-03-22T09:26:59.2527283Z   checkAllCommitMessages: true
2022-03-22T09:26:59.2527828Z   accessToken: ***
2022-03-22T09:26:59.2528079Z ##[endgroup]
2022-03-22T09:26:59.3521843Z ##[debug]Get inputs...
2022-03-22T09:26:59.3528466Z ##[debug]pattern: ^\[[^]]+\].+
2022-03-22T09:26:59.3530613Z ##[debug]flags: g
2022-03-22T09:26:59.3532515Z ##[debug]error: Your head commit must contain `[..]` like "[BUGFIX] or [SDK-974]".
2022-03-22T09:26:59.3533489Z ##[debug]excludeTitle: true
2022-03-22T09:26:59.3534633Z ##[debug]excludeDescription: true
2022-03-22T09:26:59.3535838Z ##[debug]checkAllCommitMessages: true
2022-03-22T09:26:59.3537655Z ##[debug]accessToken: ***
2022-03-22T09:26:59.3538519Z ##[debug]Get messages...
2022-03-22T09:26:59.3540001Z ##[debug] - pullRequestOptions: {
2022-03-22T09:26:59.3540440Z ##[debug]  "ignoreTitle": true,
2022-03-22T09:26:59.3540734Z ##[debug]  "ignoreDescription": true,
2022-03-22T09:26:59.3541046Z ##[debug]  "checkAllCommitMessages": true,
2022-03-22T09:26:59.3541530Z ##[debug]  "accessToken": "***"
2022-03-22T09:26:59.3541784Z ##[debug]}
2022-03-22T09:26:59.3542708Z ##[debug] - eventName: push
2022-03-22T09:26:59.3543985Z Checking commit messages against "^\[[^]]+\].+"...
2022-03-22T09:26:59.3544711Z - failed: "[CHECK] support commit checks for blocks"
2022-03-22T09:26:59.3574720Z ##[error]Error: Your head commit must contain `[..]` like "[BUGFIX] or [SDK-974]".
2022-03-22T09:26:59.3622836Z ##[debug]Node Action run completed with exit code 1
2022-03-22T09:26:59.3631887Z ##[debug]Finishing: validate commit format -- Check if HEAD commit message contains [xyz] or FAIL

is it unable to receive the github token secret? I tried creating a secret with key GITHUB_TOKEN but github showed a message that it isn't allowed

[root-ansh]

I am just running it on push:

name: task - validate commit on master
on:
  push:
    branches: [ master ]

jobs:
  lint-staticChecks-test-build:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      packages: write

    steps:
      - name: Setup actions.
        uses: actions/checkout@v2


      - name: validate commit format -- Check if HEAD commit message contains [xyz] or FAIL
        uses: gsactions/commit-message-checker@v1
        with:
          excludeDescription: 'true' 
          excludeTitle: 'true'    
          pattern: '^\[[^]]+\].+'             
          flags: 'g'
          error: 'Your head commit must contain `[..]` like "[BUGFIX] or [SDK-974]".'
          checkAllCommitMessages: 'true'
          accessToken: ${{ secrets.GITHUB_TOKEN }} 
          

don't know why but it still gives an error :(.
did you noticed these lines in my previous logs:

2022-03-22T09:26:59.3543985Z Checking commit messages against "^\[[^]]+\].+"...
2022-03-22T09:26:59.3544711Z - failed: "[CHECK] support commit checks for blocks"
2022-03-22T09:26:59.3574720Z ##[error]Error: Your head commit must contain `[..]` like "[BUGFIX] or [SDK-974]".

it correctly identified the head commit but failed for it

[gilbertsoft]

This line looks wrong checkAllCommitMessages: 'true' request

[gilbertsoft]

And using this action on a push does for me also not make much sense as at this time it's too late to fix something and your CI just goes red.

[root-ansh]

my bad, the word "request" was part of a comment that i had removed before posting here. the action seems to run without any code errors, but as you said using it for push is causing the regex to not work.
I hope you can fix it for push too. Meanwhile i can try this for PR raised and manual workflow events too. If this works, then it will be a great action to add in our pipelines. Great work @gilbertsoft !

[gilbertsoft]

There is still nothing to fix, it works here without any problems see last run https://github.com/GsActions/commit-message-checker/runs/5439031849?check_suite_focus=true

If you still have troubles you have to fix your configuration!