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

feat: add pr title checker workflow #723

Merged

Conversation

harmeetsingh11
Copy link
Contributor

@harmeetsingh11 harmeetsingh11 commented Jun 3, 2024

Issue:

This PR resolves issue #667

Close #667

Description:

This pull request addresses the need for a PR title checker to ensure conformity to conventional commit prefixes. The specified prefixes include build, chore, docs, feat, fix, perf, refactor, revert, style, and test. Consistent PR titles are essential for maintaining clarity and organization in the project's version history.

Files added

  • .github/pr-title-checker.json
  • .github/workflows/pr-title-checker.yml

Solution:

  1. Developed a PR title checker script to validate titles against the defined prefixes.
  2. Integrated the checker into the project's CI/CD pipeline for automatic validation.
  3. Defined clear error messages for non-compliant PR titles, aiding contributors in adhering to guidelines.

To run this workflow you need to enable the following permission:

  1. Go to your project repository settings
  2. On left pane > Actions > General

image

  1. Scroll down and Go to Workflow permissions > select "Read and write permissions"

image

  1. Click save and its done.

To-Do:

  • Develop and test the PR title checker script.
  • Integrate the checker into the CI/CD pipeline.
  • Define error messages for non-compliant PR titles.

@apu52 please review this PR. After merging the PR, don't forget to add gssoc , level labels and assign me PR, otherwise my points won't be added.
Thanks

Copy link

netlify bot commented Jun 3, 2024

Deploy Preview for taupe-cendol-f7e2bb ready!

Name Link
🔨 Latest commit 0c1cd2b
🔍 Latest deploy log https://app.netlify.com/sites/taupe-cendol-f7e2bb/deploys/665df3ff6d58d30009e1b85a
😎 Deploy Preview https://deploy-preview-723--taupe-cendol-f7e2bb.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @harmeetsingh11! Thank you for your valuable contribution! Our team will review it and get back to you soon.

Copy link
Owner

@apu52 apu52 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@harmeetsingh11 Thanks for your valid contribution

@apu52 apu52 merged commit cf4bedb into apu52:main Jun 5, 2024
5 checks passed
@apu52 apu52 added documentation Improvements or additions to documentation level1 gssoc labels Jun 5, 2024
@apu52
Copy link
Owner

apu52 commented Jun 5, 2024

@harmeetsingh11 from next time please try to mention the correct ISSUE NO. in the PR so that it will be very helpful for the collaborators to merge the PR & assign points .
Btw thanks for the contribution.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation gssoc level1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature]: implement PR title checker workflow for conventional commit prefixes
2 participants