Skip to content

Commit

Permalink
ci(github): workflow to ensure PR commit parity
Browse files Browse the repository at this point in the history
    Primary Changes
    ---------------
    1. Added a script which ensures PR body and commit message
       parity

    Changes needed to incorporate 1)
    --------------------------------
    2. Added a new workflow to enable the same

Fixes #2214

Signed-off-by: jagpreetsinghsasan <jagpreet.singh.sasan@accenture.com>
  • Loading branch information
jagpreetsinghsasan committed Jul 23, 2024
1 parent 81482ae commit bc90e64
Show file tree
Hide file tree
Showing 2 changed files with 87 additions and 0 deletions.
26 changes: 26 additions & 0 deletions .github/workflows/pr-commit-parity.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: PR - Commit Parity
'on':
pull_request:
branches:
- main
- dev
- petermetz/**
push:
branches:
- main
- dev

jobs:
pr-commit-parity:
name: PR and Commit messages Parity
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v3.1.0
- name: Use Node.js v18.18.2
uses: actions/setup-node@v4.0.2
with:
node-version: v18.19.0
- name: Execute pr-commit-parity script
run: |

Check failure on line 25 in .github/workflows/pr-commit-parity.yaml

View workflow job for this annotation

GitHub Actions / ActionLint / Lint_GitHub_Actions

shellcheck reported issue in this script: SC2034:warning:1:1: PR_COMMIT_PARITY_OUTPUT appears unused. Verify use (or export if used externally)
PR_COMMIT_PARITY_OUTPUT=$(node tools/pr-commit-parity.js ${{ github.event.pull_request.url }})
61 changes: 61 additions & 0 deletions tools/pr-commit-parity.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
export async function fetchJsonFromUrl(url) {
const fetchResponse = await fetch(url);
return fetchResponse.json();
}

//regex expressions
const PULL_REQ_REQUIREMENTS_REGEX = /\*\*Pull\sRequest\sRequirements(.|\n)*/gim;
const FIXES_OR_DEPENDS_REGEX = /(Fixes|Depends)(.|\n)*/gim;
const SIGNED_OFF_REGEX = /(")*Signed-off-by:(.|\s)*/gim;
const HYPHEN_REGEX = /(-)+/gm;
const BACKTICK_REGEX = /`+/gm;
const SPACE_REGEX = / +/gm;
const COMMIT_TO_BE_REVIEWED_REGEX = /("#*\s*Commit\sto\sbe\sreviewed)/gim;
const WHITESPACES_HARDCODED_REGEX = /(\r\n|\n|\r|\\r|\\n)/gm;

const args = process.argv.slice(2);
const pullReqUrl = args[0];

const prMetadata = await fetchJsonFromUrl(pullReqUrl);
const prBodyRaw = JSON.stringify(prMetadata.body);

let commitMessageList = [];
const commitMessagesMetadata = await fetchJsonFromUrl(pullReqUrl + "/commits");

commitMessagesMetadata.forEach((commitMessageMetadata) => {
commitMessageList.push(
commitMessageMetadata["commit"]["message"]
.replace(SIGNED_OFF_REGEX, "")
.replace(HYPHEN_REGEX, "")
.replace(BACKTICK_REGEX, "")
.replace(WHITESPACES_HARDCODED_REGEX, "")
.replace(FIXES_OR_DEPENDS_REGEX, "")
.replace(SPACE_REGEX, ""),
);
});

let prBodyStriped = prBodyRaw
.replace(PULL_REQ_REQUIREMENTS_REGEX, "")
.replace(FIXES_OR_DEPENDS_REGEX, "")
.replace(WHITESPACES_HARDCODED_REGEX, "")
.replace(SIGNED_OFF_REGEX, "")
.replace(HYPHEN_REGEX, "")
.replace(BACKTICK_REGEX, "")
.replace(COMMIT_TO_BE_REVIEWED_REGEX, "")
.replace(SPACE_REGEX, "");

let PR_BODY_IN_COMMIT_MESSAGES = false;
for (let commitMessageListIndex in commitMessageList) {
let commitMessage = commitMessageList[commitMessageListIndex];
if (commitMessage == prBodyStriped) PR_BODY_IN_COMMIT_MESSAGES = true;
}

if (!PR_BODY_IN_COMMIT_MESSAGES) {
console.error(
"PR Body does not match any existing commit message\n" +
"Please make sure that the PR Body matches to minimum one of the commit messages\n" +
"Please refer the following PR for reference: https://github.com/hyperledger/cacti/pull/3338\n" +
"And the commit message here: https://github.com/hyperledger/cacti/pull/3338/commits/47ebdec442d30fa48c8518b876c47c38097cf028\n",
);
process.exit(-1);
}

0 comments on commit bc90e64

Please sign in to comment.