Fix #192, Adds check commit message job in format check

[chillfig]

Checklist (Please check before submitting)

• I reviewed the Contributing Guide.
• I signed and emailed the appropriate Contributor License Agreement to [email protected] and copied [email protected].

Describe the contribution
A clear and concise description of what the contribution is.

• Fixes Check that commit messages adhere to standard using the continuous integration workflow #192

Testing performed
Tested on fork: https://github.com/chillfig/cFS/runs/6427976618?check_suite_focus=true

Expected behavior changes
Commit messages not following any of the below conventions will fail the format-check.yml

• Fix #XYZ, DESCRIPTION
• HotFix #XYZ, DESCRIPTION
• Partial #XYZ, DESCRIPTION
• Merge pull request #XYZ DESCRIPTION
• IC: DESCRIPTION

System(s) tested on
Ubuntu 18.04

Additional context
The regex for DESCRIPTION is defined as a string of 1 or more alphanumeric characters.
The regex for XYZ is defined as a string of 1 or more numeric characters.

Code contributions
The cFS repository is provided to bundle the cFS Framework. It is utilized for bundling submodules, continuous integration testing, and version management and does not contain any software. Code contributions should be directed to the appropriate submodule.

Contributor Info - All information REQUIRED for consideration of pull request
Justin Figueroa, ASRC Federal

[astrogeco]

CCB:2022-05-04, APPROVED with CHANGES

• Spin off into its own reusable workflow (triggered on workflow_call)
• Consider replacing "partial" with "part"? Do we have a "better" short word for that?

[astrogeco]

@skliper now that I think about it, for maintenance maybe we should still combine it in the "caller" workflow but restrict it to run on pull_requests? If we separate them we'll have to create and maintain one of these for each single repo.

[skliper]

@astrogeco are you able to separate it into it's own job that only runs on pull requests even when triggered from a workflow call? That would be enough to separate it from the code format check (different job) and avoid nuisance failures (only on pull request) for me. Although if there's plans to add more checking to this workflow a name update may help clarify things (not just checking code whitespace formatting anymore).

[chillfig]

@astrogeco are you able to separate it into it's own job that only runs on pull requests even when triggered from a workflow call? That would be enough to separate it from the code format check (different job) and avoid nuisance failures (only on pull request) for me. Although if there's plans to add more checking to this workflow a name update may help clarify things (not just checking code whitespace formatting anymore).

Interesting. Yes, the "Check commit message" step can be changed into its own job in format-check.yml with the addition of if: github.event_name == 'pull_request'. According to https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idif, that addition should keep the check commit message job to only running on pull requests.

[skliper]

How about "Part" vs "Partial"?

[astrogeco]

CCB:2022-05-18 APPROVED