-
Notifications
You must be signed in to change notification settings - Fork 295
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
ci(github): workflow to ensure PR description & commit message parity #2214
Comments
Further context: The above then enables you to retrieve the PR description and the PR commit's message through the GitHub API. Finally with this information being available you can run a comparison and issue a warning state on a check you wrote so that people who are the authors of a pull request where the commit message and the pull request description are mismatched can get to know about this problem. To determine the exact endpoints to use to retrieve the information above, check the GitHub REST API docs: https://docs.github.com/en/rest?apiVersion=2022-11-28 So to tie it all together: |
@zondervancalvez Some test to demonstrate what it should do on a high level: Test case 1: PR Description: "asdf" ^^ The check should pass here because everything from the PR description is present. Test case 2: ^^ The check should FAIL here because the person updated the PR description with new information that is missing from the git commit message. Test case 3: PR Description: "asdf" ^^ The check should PASS here because there was a commit in the pull request that contained the information from the PR description. It's OK if commit 1 didn't have it because at least commit 2 did so the information won't be lost. |
Primary Changes -------------- 1. Added pr-commit-parity.js script to check if the pr message and commit messages matches 2. Updated the ci.yaml to incorporate the same Fixes hyperledger-cacti#2214 Signed-off-by: jagpreetsinghsasan <[email protected]>
Primary Changes -------------- 1. Added pr-commit-parity.js script to check if the pr message and commit messages matches 2. Updated the ci.yaml to incorporate the same Fixes hyperledger-cacti#2214 Signed-off-by: jagpreetsinghsasan <[email protected]>
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 hyperledger-cacti#2214 Signed-off-by: jagpreetsinghsasan <[email protected]>
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 hyperledger-cacti#2214 Signed-off-by: jagpreetsinghsasan <[email protected]>
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 hyperledger-cacti#2214 Signed-off-by: jagpreetsinghsasan <[email protected]>
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 hyperledger-cacti#2214 Signed-off-by: jagpreetsinghsasan <[email protected]>
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 hyperledger-cacti#2214 Signed-off-by: jagpreetsinghsasan <[email protected]>
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 <[email protected]>
Description
As a maintanier/reviewer I want to have automation that makes sure that people don't just fill out the PR description on GH and leave their commit message basically empty so that the real explanation for the changes are contained in the git history and not in a database that we don't control.
Acceptance Criteria
The text was updated successfully, but these errors were encountered: