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

Implement PR Issue Checker Workflow #177

Open
siri-chandana-macha opened this issue Oct 20, 2024 · 2 comments
Open

Implement PR Issue Checker Workflow #177

siri-chandana-macha opened this issue Oct 20, 2024 · 2 comments

Comments

@siri-chandana-macha
Copy link

Description: We need to create a GitHub Actions workflow that automates the validation of pull requests (PRs). This workflow will ensure that all PRs meet the following criteria before being merged:

PR Description Check: Every PR must have a description. If the description is missing, the PR should fail the check.

Issue Reference Check: The PR description must include an issue reference in the format Fixes #. If the PR is not addressing an existing issue, it should mention Fixes #NEW as a placeholder.

Acceptance Criteria:

  • A GitHub Action workflow is triggered on PR events (opened, edited).

The workflow checks the PR body for:

  • A non-empty description.
  • The presence of Fixes # or Fixes #NEW.

If the criteria are not met:

  • The workflow should fail and return clear error messages.

If the checks pass:

  • A confirmation message is outputted.

Expected Output:

  • Error message if the PR description is missing.
  • Error message if the issue reference is missing or incorrectly formatted.
  • Success message when all checks are satisfied.

Additional Notes:
This issue may serve as a foundation for more advanced PR validation (e.g., commit message format, label enforcement).
We can later extend this to check for specific branch naming conventions or enforce the addition of specific labels.

Note : I'm expecting a gssoc-ext with level2 and hacktoberfest, hacktoberfest-accepted label!
@OpenTekHub

Copy link

👋 Hello @siri-chandana-macha! Thank you for opening this issue titled "Implement PR Issue Checker Workflow"! We're excited to see your contribution and a maintainer will get back to you shortly 😊!

Please ensure the following:

  1. Be respectful.
  2. Follow the contribution guidelines.

Happy coding! 🚀

Copy link

Hi there! Thanks for opening this issue. We appreciate your contribution to this open-source project. We aim to respond or assign your issue as soon as possible.

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

No branches or pull requests

1 participant