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

Closed
smog-root opened this issue Oct 20, 2024 · 4 comments · Fixed by #1556
Closed

Implement PR Issue Checker Workflow #1543

smog-root opened this issue Oct 20, 2024 · 4 comments · Fixed by #1556

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!

@apu52

Copy link

Hi @smog-root! Thanks for opening this issue. We appreciate your contribution to this open-source project.

@smog-root
Copy link
Contributor Author

smog-root commented Oct 21, 2024

i will add the following features! can you make it level3?

  1. Auto comment on issue Closed and Opened
  2. Auto comment on PR mergs
  3. Auto comment on PR raises

@apu52

@apu52
Copy link
Owner

apu52 commented Oct 21, 2024

i will add the following features! can you make it level3?

  1. Auto comment on issue Closed and Opened
  2. Auto comment on PR mergs
  3. Auto comment on PR raises

@apu52

I will but don't make any workflow to automate PR merging
I will label it as per my review of the PR

Copy link

✅ This issue has been successfully closed. Thank you for your contribution and helping us improve the project! If you have any more ideas or run into other issues, feel free to open a new one. Happy coding! 🚀

@apu52 apu52 added the level1 label Oct 26, 2024
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.

2 participants