[infra] Enforce type labels on PRs #275
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit introduces a GitHub Action to ensure pull requests have exactly one type label. If no label or multiple labels are found, an explanatory comment is left on the PR. This helps standardize PR categorization and improve workflow consistency. This may as well make the "Check if PR has label" workflow obsolete
Add a `core.setFailed` call to ensure the workflow fails if a PR is merged without valid type labels. This prevents incomplete label verification from being bypassed, ensuring stricter adherence to standards.
This update includes 'dependencies' as an allowed label for PRs. It ensures better categorization and aligns with the labeling standards for managing dependency-related changes.
michelengelen
added
the
scope: infra
michelengelen
requested review from
oliviertassinari,
mnajdova,
DanailH and
JCQuintas
JCQuintas
approved these changes
Feb 27, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces a new GitHub Actions workflow and a supporting script to ensure that pull requests have appropriate type labels. The most important changes include the creation of the workflow file and the implementation of the script to check for type labels.
New workflow for checking PR type labels:
.github/workflows/prs_check-if-pr-has-type-label.yml: Added a new workflow to check if pull requests have appropriate type labels. This workflow runs on a PR event and uses theactions/checkoutandactions/github-scriptactions to execute the label checking script.Implementation of the label checking script:
.github/workflows/scripts/prs/checkTypeLabel.js: Added a script that verifies the presence of type labels on pull requests. The script checks for specific labels, creates comments on the PR if the labels are missing or incorrect, and fails the workflow to prevent merging without proper labels.PRs should be labeled according to their purpose.
release,bug/regressionandenhancement/new featureshould be self explanatory.maintenanceis meant to categorize refactors, cleanups and structural changes.dependenciesis similar, but not quite the same. We could potentially combine the two into one.