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 codeql and pr title checker workflow #360

Conversation

harmeetsingh11
Copy link
Contributor

Issue that this pull request solves

Closes: #359

Description:

This pull request introduces a CodeQL workflow specifically tailored for JavaScript to enhance code scanning capabilities and 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
  • .github/workflows/codeql.yml

Solution:

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

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update (Documentation content changed)
  • Other (please describe):

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • My changes generate no new warnings

@Kritika30032002 please review this PR.
Thanks

Copy link

netlify bot commented Feb 4, 2024

Deploy Preview for simply-tasked-list ready!

Name Link
🔨 Latest commit 6dd4237
🔍 Latest deploy log https://app.netlify.com/sites/simply-tasked-list/deploys/65c0a46dd76f260008c3d7ed
😎 Deploy Preview https://deploy-preview-360--simply-tasked-list.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.

@Kritika30032002 Kritika30032002 merged commit d7f1ffa into Kritika30032002:main Feb 5, 2024
6 checks passed
@github-advanced-security
Copy link

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

@harmeetsingh11
Copy link
Contributor Author

@Kritika30032002 can you please add iwoc24 and difficulty level label to the PR, otherwise my points won't count.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants