validate pr type also separated

2026-09-02 20:50:42 +02:00 · 2026-08-28 14:50:48 +02:00
parent 27d678ee1d
commit ca5b8a4b75
1 changed files with 204 additions and 0 deletions
@@ -0,0 +1,204 @@
+# This reusable workflow reads the primary type and breaking api selection from the PR description and validates the PR labels. It ensures that exactly one primary type is selected, and that the Breaking API label is consistent with the checkbox in the PR description. It also adds or removes labels as necessary to match the PR description.
+
+name: PR Type Validation
+
+on:
+  workflow_call:
+    inputs:
+      pr_number:
+        required: true
+        type: number
+
+permissions:
+  pull-requests: write
+  contents: read
+
+jobs:
+  validate_pr_type:
+    name: PR Type Validation
+    runs-on: ubuntu-latest
+    outputs:
+      validated: ${{ steps.validate.outputs.validated }}
+
+    steps:
+      - name: PR Type Validation and Breaking API
+        id: validate
+        uses: actions/github-script@v8
+        with:
+          script: |
+            core.setOutput('validated', 'true');  
+
+            /*
+             * If triggered by label change, ignore unrelated labels.
+             */
+            const action = context.payload.action;
+            if (action === 'labeled' || action === 'unlabeled') {
+              const changedLabel = context.payload.label?.name;
+
+              const relevantLabels = [
+                'Feature',
+                'Bug Fix',
+                'Infrastructure',
+                'Breaking API'
+              ];
+
+              if (!relevantLabels.includes(changedLabel)) {
+                core.info(
+                  `Ignoring unrelated label change: ${changedLabel}`
+                );
+                core.setOutput('validated', 'false');
+                return;
+              }
+            }     
+
+            /*
+             * Read the body contents of PR
+             */
+            const prNumber = context.payload.pull_request?.number;
+
+            if (!prNumber) {
+              core.setFailed('Unable to determine PR number.');
+              return;
+            }
+
+            const { data: pr } =
+              await github.rest.pulls.get({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                pull_number: prNumber
+              });
+
+            const body = pr.body || '';
+
+            /*
+             * Check which primary PR type is selected.
+             */
+            const feature =
+              /-\s*\[[xX]\]\s*Feature\b/.test(body);
+
+            const bugFix =
+              /-\s*\[[xX]\]\s*Bug Fix\b/.test(body);
+
+            const infrastructure =
+              /-\s*\[[xX]\]\s*Infrastructure\b/.test(body);
+
+            const primaryTypes = [
+              feature && 'Feature',
+              bugFix && 'Bug Fix',
+              infrastructure && 'Infrastructure'
+            ].filter(Boolean);
+
+            /*
+             * Exactly one primary PR type must be selected.
+             */
+            if (primaryTypes.length !== 1) {
+              core.setFailed(
+                'Exactly one primary PR type must be selected. Select exactly one of: Feature, Bug Fix, Infrastructure in the description.'
+              );
+              return;
+            }
+
+            const primaryType = primaryTypes[0];
+
+            /*
+             * Infrastructure PRs cannot be Breaking API.
+             */
+            const breakingApi =
+              /-\s*\[[xX]\]\s*This is a Breaking API change\b/.test(body);
+
+            if (infrastructure && breakingApi) {
+              core.setFailed(
+                'Infrastructure PRs cannot be Breaking API changes. Deselect Breaking API or change the PR type to Feature or Bug Fix in the description.'
+              );
+              return;
+            }
+
+            core.info(`Primary PR type: ${primaryType}`);
+            core.info(
+              `Breaking API: ${breakingApi ? 'yes' : 'no'}`
+            );
+
+            /*
+             * Get the labels currently on the PR.
+             */
+            const { data: currentLabels } =
+              await github.rest.issues.listLabelsOnIssue({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                issue_number: prNumber
+              });
+
+            const currentLabelNames =
+              currentLabels.map(label => label.name);
+
+            const primaryLabels = [
+              'Feature',
+              'Bug Fix',
+              'Infrastructure'
+            ];
+
+            const selectedPrimary =
+              primaryLabels.filter(label =>
+                currentLabelNames.includes(label)
+              );
+
+            if (selectedPrimary.length > 1) {
+              core.setFailed(
+                `Invalid PR label state: multiple primary labels are present: ${selectedPrimary.join(', ')}. Remove these primary type labels 'Feature, Bug Fix, Infrastructure' and let the workflow set the correct label based on the PR description.`
+              );
+              return;
+            }
+
+            if (selectedPrimary.length === 1 && selectedPrimary[0] !== primaryType) {
+              core.setFailed(
+                `Invalid PR label state: the PR body selects ${primaryType}, but the existing label is ${selectedPrimary[0]}. Remove the existing label and let the workflow set the correct label based on the PR description.`
+              );
+              return;
+            }
+
+            if (
+              currentLabelNames.includes('Breaking API') &&
+              infrastructure
+            ) {
+              core.setFailed(
+                'Infrastructure PRs cannot have the Breaking API label.'
+              );
+              return;
+            }
+
+            if (
+              !breakingApi &&
+              currentLabelNames.includes('Breaking API')
+            ) {
+              core.setFailed(
+                'Breaking API label is present but the PR body does not mark the checkbox. Remove the label or check the checkbox in the PR body.'
+              );
+              return;
+            }
+
+            if (
+              breakingApi &&
+              !currentLabelNames.includes('Breaking API')
+            ) {
+              await github.rest.issues.addLabels({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                issue_number: prNumber,
+                labels: ['Breaking API']
+              });
+
+              core.info('Added label: Breaking API');
+            }
+
+            if (!currentLabelNames.includes(primaryType)) {
+              await github.rest.issues.addLabels({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                issue_number: prNumber,
+                labels: [primaryType]
+              });
+
+              core.info(`Added label: ${primaryType}`);
+            }
+
+            core.info('PR validation passed.');