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 #108

Closed
smog-root opened this issue Oct 19, 2024 · 5 comments · Fixed by #114
Closed

Implement PR Issue Checker Workflow #108

smog-root opened this issue Oct 19, 2024 · 5 comments · Fixed by #114

Comments

@smog-root
Copy link
Contributor

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 level3 (or) level2 and a hacktoberfest-accepted label!

@ombhojane

Copy link

👋 Thank you for raising an issue! We appreciate your effort in helping us improve. Our team will review it shortly. Stay tuned!

@SKG24
Copy link

SKG24 commented Oct 20, 2024

I think i can do this. Please assign it to me

@smog-root
Copy link
Contributor Author

I think i can do this. Please assign it to me

I don't need any assistance. I can do it!@SKG24

@ombhojane
Copy link
Owner

Okayy @smog-root go ahead!

Copy link

Hello @smog-root! Your issue #108 has been closed. Thank you for your contribution!🚀

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

Successfully merging a pull request may close this issue.

3 participants