joshjohanning/azdo_commit_message_validator

GitHub Action to enforce commits are linked to Azure Boards work items, and link the work item to the pull request

Hi there 👋

⚡ I am a Senior DevOps Architect with GitHub on the FastTrack team 🚀

⚡ Previously I was a Senior Cloud Automation Engineer with the Cognizant Microsoft Business Group (formerly 10th Magnitude)

⚡ I store my miscellaneous GitHub scripts in github-misc-scripts repo

⚡ I use my ghas-demo repository for my GitHub Advanced Security Demo - see PDF here

⚡ I have been an avid user of Azure Pipelines and have my pipeline templates consolidated in my pipeline-templates repo

⚡ I blog about my DevOps experiences at josh-ops.com

⚡ To contact me:

• 🌱 Leave a comment on one of my posts!
• 🌱 Message me on LinkedIn

azdo_commit_message_validator's Issues

Use ${{ github.action_path }}

Use ${{ github.action_path }} instead of hardcoded path here:

https://github.com/joshjohanning/azdo_commit_message_validator/blob/main/action.yml#L59C1-L59C79

        main=$(find ../../_actions/joshjohanning/azdo_commit_message_validator -name "main.js" | grep -v "node_modules")

npm install

Forgot to npm install before we commit (otherwise was requiring users to add the npm install correctly ahead of time which is not ideal)

[Question] does this support push events?

@joshjohanning ,

I hope you are doing well.

I was wondering if this GitHub Action supports Push events and if the commit validator follows the conventional commits validation since in the examples the commits only have AB#... without a colon and a commit message. ,e.g

AB#0000 feat: my new feature

Validate that work item exists

In addition to seeing if there is a valid link, ie AB#xyz, validate that it is a valid work item. This will require Azure DevOps PAT.

Support disabling comment on failure

Already have the input:

  comment-on-failure:
    description: "Comment on the pull request if the action fails"
    required: true
    default: true

Should we rename `fail-if-missing-workitem-commit-link` to be generic (also be for PRs?)

Right now this is only for commits. This could make sense since commits are more restrictive to update (requires force pushing).

Test if GitHub Enterprise Server linkage works

Added support here, test it:

• 21d8219

Add comment to PR if failing with information

When I added the PR work item link checker, I added comment support.

Add to the commits as well.

Check for prerequisite software

Test to see if gh and jq are installed

Allow customization of PR error message comment

Add an input for customizing the error message.

Would have to change the way we are checking to see if there is a comment there already (maybe use a tag or comment prefix)?

Update JSON5 dependency

There is a prototype pollution security alert

Improve commit message matching check

We're using a hacky check right now

            if [[ "$COMMIT_MESSAGE" != *"AB"\#""[0-9]""* ]] && [[ "$COMMIT_MESSAGE" != *"ab"\#""[0-9]""* ]]; then

Use grep to make this cleaner?

            if ! echo "$COMMIT_MESSAGE" | grep -i -E -q "AB#[0-9]+"; then

Can we do the same to validate the description of the pull request

Can we validate the description of the pullrequest to make sure the user story is linked in the description instead of the commit message ?

Support GitHub Enterprise Server

Don't hardcode GitHub URL (ie: github.com) so that GitHub Enterprise Server instances work

cc

• #62

Validate that commit check or pr check is enabled

If both check-commits and check-pull-request is false, fail the action (at least 1 should be enabled)

Update the PR comment if there was a success

We update on failure (if there is an existing comment) - should also do this if success (so that the user knows they are good now)

If `link-commits-to-pull-request` is true, verify Azure DevOps Org and PAT are set

Verify that both are not empty

if ${{ inputs.link-commits-to-pull-request }}; then
  # make the call to main.js to do the linking
  # TODO: check to see if org/pat are set
  echo "Attempting to link work item ${WORKITEM} to pull request ${PULL_NUMBER}..."
  REPO_TOKEN=${{ inputs.github-token }} AZURE_DEVOPS_ORG=${{ inputs.azure-devops-organization }} AZURE_DEVOPS_PAT=${{ inputs.azure-devops-token }} WORKITEMID=$WORKITEM PULLREQUESTID=${{ github.event.number }} REPO=${{ github.repository }} node $main
  echo "...PR linked to work item"
fi

Add information on linkage to job summary or `::info`

From the job, make it easier to see what work item(s) were linked to PR

  echo "Pull request linked to work item number: $WORKITEM_NUMBER"
  # TODO: validate work item?
  # TODO: add this as an ::info or to the job summary?