Skip to content
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): commit parity check based on similarity #3504

Merged
merged 1 commit into from
Sep 4, 2024

Conversation

jagpreetsinghsasan
Copy link
Contributor

Commit to be reviewed

ci(github): commit parity check based on similarity

Primary Changes
---------------
1. Added a commit-pr similarity ratio to lessen the check strictness
2. Added an env var to the workflow to easily control the similarity
   ratio

Changes required to incorporate 1)
---------------------------------
3. Added string-similarity-js package in package.json

Fixes #3470

Pull Request Requirements

  • Rebased onto upstream/main branch and squashed into single commit to help maintainers review it more efficient and to avoid spaghetti git commit graphs that obfuscate which commit did exactly what change, when and, why.
  • Have git sign off at the end of commit message to avoid being marked red. You can add -s flag when using git commit command. You may refer to this link for more information.
  • Follow the Commit Linting specification. You may refer to this link for more information.

Character Limit

  • Pull Request Title and Commit Subject must not exceed 72 characters (including spaces and special characters).
  • Commit Message per line must not exceed 80 characters (including spaces and special characters).

A Must Read for Beginners
For rebasing and squashing, here's a must read guide for beginners.

@RafaelAPB
Copy link
Contributor

Could you please elaborate a bit on why do we need this?

@jagpreetsinghsasan
Copy link
Contributor Author

Could you please elaborate a bit on why do we need this?

Sure @RafaelAPB .
Right now our commit PR parity check is basically a check to see if the PR message we write matches exactly to that of the commit message.
This PR loosens that check by checking for string similarity instead of checking for string equality.
Here's the conversation with Peter around the same: https://github.com/hyperledger/cacti/issues/3470#issuecomment-2287141374

@RafaelAPB
Copy link
Contributor

@jagpreetsinghsasan thank you for your explanation. I like this contribution, thanks!

    Primary Changes
    ---------------
    1. Added a commit-pr similarity ratio to lessen the check strictness
    2. Added an env var to the workflow to easily control the similarity
       ratio

    Changes required to incorporate 1)
    ---------------------------------
    3. Added string-similarity-js package in package.json

Fixes hyperledger-cacti#3470

Signed-off-by: jagpreetsinghsasan <jagpreetsinghsasan@accenture.com>
@petermetz petermetz merged commit a861df7 into hyperledger-cacti:main Sep 4, 2024
147 checks passed
@petermetz petermetz deleted the feat-3470 branch September 4, 2024 20:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ci(github): commit parity check for PRs should show what is wrong
4 participants