Make remove-label workflow boxes more clear

Author: UltraProdigy

.github/workflows/remove-labels.yml

@@ -4,27 +4,27 @@ on:
   workflow_dispatch:
     inputs:
       run_on_issues:
-        description: "Remove the label from issues in the configured repository set"
+        description: "Remove from Issues"
         required: true
         type: boolean
         default: true
-      closed_only:
-        description: "When Run on Issues is enabled, only target closed issues"
+      target_only_closed_issues:
+        description: "Target Only Closed Issues"
         required: true
         type: boolean
         default: false
       run_on_pull_requests:
-        description: "Remove the label from pull requests in the configured repository set"
+        description: "Remove from Pull Requests"
         required: true
         type: boolean
         default: false
-      merged_only:
-        description: "When Run on Pull Requests is enabled, only target merged pull requests"
+      target_only_closed_pull_requests:
+        description: "Target Only Closed Pull Requests"
         required: true
         type: boolean
         default: false
       label_name:
-        description: "Exact label name to remove"
+        description: "Exact Name of Label:"
         required: true
         type: string
 
@@ -59,8 +59,8 @@ jobs:
         env:
           LABEL_SYNC_TOKEN: ${{ secrets[steps.properties.outputs.label_sync_token_secret_name] }}
           RUN_ON_ISSUES: ${{ inputs.run_on_issues }}
-          CLOSED_ONLY: ${{ inputs.closed_only }}
+          TARGET_ONLY_CLOSED_ISSUES: ${{ inputs.target_only_closed_issues }}
           RUN_ON_PULL_REQUESTS: ${{ inputs.run_on_pull_requests }}
-          MERGED_ONLY: ${{ inputs.merged_only }}
+          TARGET_ONLY_CLOSED_PULL_REQUESTS: ${{ inputs.target_only_closed_pull_requests }}
           LABEL_NAME: ${{ inputs.label_name }}
         run: node scripts/remove-labels.mjs

README.md

@@ -236,9 +236,9 @@ Trigger:
 Inputs:
 
 - `run_on_issues`: remove the label from matching issues
-- `closed_only`: when `run_on_issues` is enabled, only target closed issues
+- `target_only_closed_issues`: when `run_on_issues` is enabled, only target closed issues
 - `run_on_pull_requests`: remove the label from matching pull requests
-- `merged_only`: when `run_on_pull_requests` is enabled, only target merged pull requests
+- `target_only_closed_pull_requests`: when `run_on_pull_requests` is enabled, only target closed pull requests
 - `label_name`: exact label name to remove
 
 What it does:
@@ -252,7 +252,7 @@ What it does:
 
 Notes:
 
-- GitHub Actions does not currently support conditionally hiding or nesting `workflow_dispatch` inputs, so `closed_only` and `merged_only` can be described as dependent toggles but not visually tucked under their parent checkboxes.
+- GitHub Actions does not currently support conditionally hiding or nesting `workflow_dispatch` inputs, so the closed-only toggles can be described as dependent but not visually tucked under their parent checkboxes.
 
 ## Token Requirements
 

scripts/remove-labels.mjs

@@ -7,9 +7,9 @@ const repositoryFilterPath = path.join(workspaceRoot, "config", "repository-filt
 
 const validateOnly = process.argv.includes("--validate-only");
 const runOnIssues = parseBoolean(process.env.RUN_ON_ISSUES);
-const closedOnly = parseBoolean(process.env.CLOSED_ONLY) ?? false;
+const targetOnlyClosedIssues = parseBoolean(process.env.TARGET_ONLY_CLOSED_ISSUES) ?? false;
 const runOnPullRequests = parseBoolean(process.env.RUN_ON_PULL_REQUESTS);
-const mergedOnly = parseBoolean(process.env.MERGED_ONLY) ?? false;
+const targetOnlyClosedPullRequests = parseBoolean(process.env.TARGET_ONLY_CLOSED_PULL_REQUESTS) ?? false;
 const labelName = (process.env.LABEL_NAME ?? "").trim();
 
 function parseBoolean(value) {
@@ -182,10 +182,6 @@ function findMatchingLabel(issueOrPullRequest, requestedLabel) {
   return labels.find((label) => label && typeof label.name === "string" && normalizeName(label.name) === requestedKey) ?? null;
 }
 
-async function getPullRequestDetails(token, repositoryFullName, number) {
-  return githubRequest(token, "GET", `/repos/${repositoryFullName}/pulls/${number}`);
-}
-
 async function removeLabelFromIssue(token, repositoryFullName, number, actualLabelName) {
   await githubRequest(
     token,
@@ -195,7 +191,7 @@ async function removeLabelFromIssue(token, repositoryFullName, number, actualLab
 }
 
 async function processIssues(token, repository, requestedLabel) {
-  const state = closedOnly ? "closed" : "all";
+  const state = targetOnlyClosedIssues ? "closed" : "all";
   const candidates = await getLabelledIssues(token, repository.full_name, state, requestedLabel);
   const issues = candidates.filter((item) => !item.pull_request);
   let removed = 0;
@@ -216,7 +212,7 @@ async function processIssues(token, repository, requestedLabel) {
 }
 
 async function processPullRequests(token, repository, requestedLabel) {
-  const state = mergedOnly ? "closed" : "all";
+  const state = targetOnlyClosedPullRequests ? "closed" : "all";
   const candidates = await getLabelledIssues(token, repository.full_name, state, requestedLabel);
   const pullRequests = candidates.filter((item) => item.pull_request);
   let removed = 0;
@@ -228,14 +224,6 @@ async function processPullRequests(token, repository, requestedLabel) {
       continue;
     }
 
-    if (mergedOnly) {
-      const details = await getPullRequestDetails(token, repository.full_name, pullRequest.number);
-
-      if (!details.merged_at) {
-        continue;
-      }
-    }
-
     await removeLabelFromIssue(token, repository.full_name, pullRequest.number, matchingLabel.name);
     removed += 1;
     console.log(`  Removed "${matchingLabel.name}" from pull request #${pullRequest.number}`);