make github label pruning a checkbox and format fixes

Author: UltraProdigy

.github/workflows/org-label-sync.yml

@@ -9,10 +9,15 @@ on:
         type: boolean
         default: false
       delete_missing:
-        description: "Delete labels that are not present in config"
+        description: "Delete extra non-default labels that are not present in config"
         required: false
         type: boolean
         default: false
+      delete_github_default_labels:
+        description: "Delete Github default labels"
+        required: false
+        type: boolean
+        default: true
       repositories:
         description: "Config Override: Run workflow on this set of repositories exclusively. (Type name(s), separated by comma)"
         required: false
@@ -73,6 +78,7 @@ jobs:
           ORG_NAME: ${{ steps.properties.outputs.organization }}
           DRY_RUN: ${{ inputs.dry_run }}
           DELETE_MISSING: ${{ inputs.delete_missing }}
+          DELETE_GITHUB_DEFAULT_LABELS: ${{ inputs.delete_github_default_labels }}
           TARGET_REPOSITORIES: ${{ inputs.repositories }}
         run: node scripts/sync-labels.mjs
 

.github/workflows/remove-labels.yml

@@ -4,7 +4,7 @@ on:
   workflow_dispatch:
     inputs:
       run_on_issues:
-        description: "Remove from Issues"
+        description: "Remove From Issues"
         required: true
         type: boolean
         default: true
@@ -14,10 +14,10 @@ on:
         type: boolean
         default: false
       run_on_pull_requests:
-        description: "Remove from Pull Requests"
+        description: "Remove From Pull Requests"
         required: true
         type: boolean
-        default: false
+        default: true
       target_only_closed_pull_requests:
         description: "Target Only Closed Pull Requests"
         required: true

README.md

@@ -48,7 +48,7 @@ The reverse flow is:
 |       |-- reverse-config-label-sync.yml
 |       `-- validate-configs.yml
 |-- config/
-|   |-- auto-pruned-labels.jsonc
+|   |-- github-default-labels.jsonc
 |   |-- labels.jsonc
 |   |-- properties.jsonc
 |   `-- repository-filter.jsonc
@@ -134,17 +134,19 @@ Example:
 ]
 ```
 
-### `config/auto-pruned-labels.jsonc`
+### `config/github-default-labels.jsonc`
 
-This is the list of exact labels that should be removed from synced repositories when they are not managed by `config/labels.jsonc`.
+This is the list of exact GitHub default labels that can be removed from synced repositories when they are not managed by `config/labels.jsonc`.
+
+You will likely never need to modify this file unless GitHub changes the default labels it creates for new repositories.
 
 Each entry must include:
 
 - `name`
 - `color`
 - `description`
 
-The starter file is prefilled with GitHub's default labels as exact specs:
+The file is prefilled with GitHub's default labels as exact specs:
 
 ```jsonc
 [
@@ -161,9 +163,9 @@ The starter file is prefilled with GitHub's default labels as exact specs:
 ]
 ```
 
-`Org-Label-Sync` only deletes a configured auto-pruned label when the target repository label has the same name casing, color, and description. A custom label such as `Enhancement`, or an `enhancement` label with a different description or color, is not deleted by this file.
+`Org-Label-Sync` only deletes an entry from this file when the `delete_github_default_labels` workflow checkbox is checked and the target repository label has the same name casing, color, and description. A custom label such as `Enhancement`, or an `enhancement` label with a different description or color, is not deleted as a GitHub default label.
 
-Managed labels are the source of truth. If a label exists in `config/labels.jsonc`, it is created or updated on target repositories and is not deleted by `config/auto-pruned-labels.jsonc`, even when it has the same name as an auto-pruned default.
+Managed labels are the source of truth. If a label exists in `config/labels.jsonc`, it is created or updated on target repositories and is not deleted by `config/github-default-labels.jsonc`, even when it has the same name as a GitHub default label.
 
 ### `config/repository-filter.jsonc`
 
@@ -216,7 +218,7 @@ What it does:
 3. Resolves either the configured PAT or a GitHub App installation token
 4. Reads the current labels on the source repository
 5. Rewrites `config/labels.jsonc` so it exactly matches the source repository labels
-6. Validates `config/auto-pruned-labels.jsonc` so exact default-delete specs remain well-formed
+6. Validates `config/github-default-labels.jsonc` so exact GitHub default label specs remain well-formed
 7. Commits and pushes the change if the config was updated
 
 This workflow is the bridge between "the labels on this repo right now" and "the managed config we sync elsewhere."
@@ -244,7 +246,7 @@ Validation includes:
 - duplicate whitelist and blacklist detection
 - invalid colors
 - invalid repo names
-- exact auto-pruned label shape validation
+- exact GitHub default label shape validation
 - validation for the shared config used by `Remove-Labels`
 
 ### `Reverse-Config-Label-Sync`
@@ -264,7 +266,7 @@ What it does:
 5. Resolves either the configured PAT or a GitHub App installation token
 6. Validates the config again as a local guard
 7. Creates or updates source repository labels from `config/labels.jsonc`
-8. Deletes exact auto-pruned labels and any other source repository labels that are not in `config/labels.jsonc`
+8. Deletes exact GitHub default labels and any other source repository labels that are not in `config/labels.jsonc`
 
 This workflow is the bridge from "the managed config was changed by a person" back to "the source repository label settings should now match that config."
 
@@ -280,6 +282,7 @@ Inputs:
 
 - `dry_run`: preview changes without applying repository label changes; when previewed changes exist, writes a fake changelog under `fake-changelogs/`
 - `delete_missing`: delete extra labels that are not in `config/labels.jsonc`; unchecked keeps extra labels
+- `delete_github_default_labels`: delete exact GitHub default labels from `config/github-default-labels.jsonc`; checked by default, unchecked keeps them
 - `repositories`: comma-separated config override that runs exclusively on those repositories and ignores `repository-filter.jsonc`
 
 What it does:
@@ -292,8 +295,8 @@ What it does:
 6. Discovers repos in the configured organization
 7. Applies `config/repository-filter.jsonc`, unless `repositories` was provided as a workflow dispatch config override
 8. Creates or updates labels from `config/labels.jsonc`
-9. Deletes labels that exactly match entries in `config/auto-pruned-labels.jsonc` unless that label name is managed by `config/labels.jsonc`
-10. Optionally deletes any other unmanaged labels only when the `delete_missing` workflow checkbox is checked
+9. Deletes labels that exactly match entries in `config/github-default-labels.jsonc` only when the `delete_github_default_labels` workflow checkbox is checked, unless that label name is managed by `config/labels.jsonc`
+10. Optionally deletes any other unmanaged labels only when the `delete_missing` workflow checkbox is checked; exact GitHub default labels are reserved for `delete_github_default_labels`
 11. If at least one target repo changed or would change, writes a changelog and commits it with `[skip ci]`; real runs write to `changelogs/YYYY-MM-DD/`, while preview runs write fake changelogs to `fake-changelogs/YYYY-MM-DD/` and do not apply repository changes
 
 ### `Remove-Labels`
@@ -333,7 +336,7 @@ Each changelog file is created only when a workflow actually changes, or in prev
 
 - created labels
 - updated labels, including changed fields
-- configured auto-pruned labels that were deleted
+- GitHub default labels that were deleted
 - unmanaged labels that were deleted when delete-missing is enabled
 
 `Remove-Labels` changelogs include:
@@ -376,7 +379,7 @@ The GitHub App installation must be granted access to this configuration reposit
 1. Fork or clone this repository into the organization you want to manage.
 2. Create either the PAT secret or the GitHub App secrets in the repo.
 3. Update `config/properties.jsonc` for your org, repo, and auth mode.
-4. Adjust `config/auto-pruned-labels.jsonc` if you want different exact default-delete specs.
+4. Leave `config/github-default-labels.jsonc` alone unless GitHub changes its default labels.
 5. Configure `config/repository-filter.jsonc` for blacklist mode or whitelist mode.
 6. Set the labels on this repository to the label set you want to manage.
 7. Run `Config-Label_Sync` once if you want to populate `config/labels.jsonc` immediately.
@@ -386,5 +389,5 @@ The GitHub App installation must be granted access to this configuration reposit
 
 - `labels.jsonc` starts empty until you define or sync labels on this repo
 - all repos in the org are targeted unless excluded by `repository-filter.jsonc`
-- GitHub default labels are auto-pruned by default only when they exactly match the stored name, color, and description and are not managed in `labels.jsonc`
+- GitHub default labels are pruned by default when they exactly match `config/github-default-labels.jsonc`; uncheck `delete_github_default_labels` to keep them
 - deleting unmanaged labels is off by default unless you check `delete_missing` when running `Org-Label-Sync`

config/auto-pruned-labels.jsonc config/github-default-labels.jsoncconfig/auto-pruned-labels.jsonc renamed to config/github-default-labels.jsonc

@@ -1,3 +1,6 @@
+// GitHub's default label set rarely changes.
+// You will likely never need to modify this file unless GitHub changes the default labels it creates for new repositories.
+//
 // Example:
 // [
 //   {

scripts/lib/changelog-utils.mjs

@@ -122,13 +122,13 @@ export function renderLabelSyncSection(result) {
     lines.push("");
   }
 
-  const deletedConfigured = renderList(
-    result.deletedConfiguredLabels,
-    (label) => `Deleted configured auto-pruned label \`${label.name}\``,
+  const deletedGithubDefaults = renderList(
+    result.deletedGithubDefaultLabels,
+    (label) => `Deleted GitHub default label \`${label.name}\``,
   );
-  if (deletedConfigured) {
-    lines.push("Deleted configured labels:");
-    lines.push(deletedConfigured);
+  if (deletedGithubDefaults) {
+    lines.push("Deleted GitHub default labels:");
+    lines.push(deletedGithubDefaults);
     lines.push("");
   }
 

scripts/lib/config-validation.mjs

@@ -197,20 +197,20 @@ export function validateLabels(labels) {
   });
 }
 
-export function validateDeleteLabels(deleteLabels) {
-  assert(Array.isArray(deleteLabels), "config/auto-pruned-labels.jsonc must contain an array.");
+export function validateGithubDefaultLabels(githubDefaultLabels) {
+  assert(Array.isArray(githubDefaultLabels), "config/github-default-labels.jsonc must contain an array.");
 
   const seen = new Set();
 
-  return deleteLabels.map((entry, index) => {
-    assert(entry && typeof entry === "object" && !Array.isArray(entry), `Delete label at index ${index} must be an object.`);
-    assert(typeof entry.name === "string" && entry.name.trim(), `Delete label at index ${index} is missing a valid name.`);
-    assert(typeof entry.color === "string" && /^[0-9a-fA-F]{6}$/.test(normalizeColor(entry.color)), `Delete label "${entry.name}" must have a 6-character hex color.`);
-    assert(typeof entry.description === "string", `Delete label "${entry.name}" must include a string description.`);
+  return githubDefaultLabels.map((entry, index) => {
+    assert(entry && typeof entry === "object" && !Array.isArray(entry), `GitHub default label at index ${index} must be an object.`);
+    assert(typeof entry.name === "string" && entry.name.trim(), `GitHub default label at index ${index} is missing a valid name.`);
+    assert(typeof entry.color === "string" && /^[0-9a-fA-F]{6}$/.test(normalizeColor(entry.color)), `GitHub default label "${entry.name}" must have a 6-character hex color.`);
+    assert(typeof entry.description === "string", `GitHub default label "${entry.name}" must include a string description.`);
 
     const normalized = normalizeLabelSpec(entry);
     const key = labelSpecKey(normalized);
-    assert(!seen.has(key), `Duplicate exact delete label detected: "${normalized.name}".`);
+    assert(!seen.has(key), `Duplicate GitHub default label detected: "${normalized.name}".`);
     seen.add(key);
     return normalized;
   });

scripts/reverse-config-label-sync.mjs

@@ -8,15 +8,15 @@ import {
   readJsonc,
 } from "./lib/config-utils.mjs";
 import {
-  validateDeleteLabels,
+  validateGithubDefaultLabels,
   validateLabels,
   validateProperties,
 } from "./lib/config-validation.mjs";
 
 const workspaceRoot = process.cwd();
 const propertiesPath = path.join(workspaceRoot, "config", "properties.jsonc");
 const labelsPath = path.join(workspaceRoot, "config", "labels.jsonc");
-const autoPrunedLabelsPath = path.join(workspaceRoot, "config", "auto-pruned-labels.jsonc");
+const githubDefaultLabelsPath = path.join(workspaceRoot, "config", "github-default-labels.jsonc");
 
 const validateOnly = process.argv.includes("--validate-only");
 const dryRun = validateOnly || process.env.DRY_RUN === "true";
@@ -77,19 +77,19 @@ function summarizeLabelDiff(existing, desired) {
   return "update";
 }
 
-function isExactAutoPrunedLabel(label, deleteLabels) {
-  return deleteLabels.some((deleteLabel) => labelsExactlyMatch(label, deleteLabel));
+function isExactGithubDefaultLabel(label, githubDefaultLabels) {
+  return githubDefaultLabels.some((githubDefaultLabel) => labelsExactlyMatch(label, githubDefaultLabel));
 }
 
-async function syncSourceRepository(token, repository, desiredLabels, deleteLabels) {
+async function syncSourceRepository(token, repository, desiredLabels, githubDefaultLabels) {
   console.log(`Syncing ${repository} labels from config`);
   const existingLabels = await getAllLabels(token, repository);
   const existingByName = new Map(existingLabels.map((label) => [normalizeName(label.name), label]));
   const desiredKeys = new Set(desiredLabels.map((label) => normalizeName(label.name)));
 
   let created = 0;
   let updated = 0;
-  let deletedConfigured = 0;
+  let deletedGithubDefaults = 0;
   let deletedMissing = 0;
   let unchanged = 0;
 
@@ -130,12 +130,12 @@ async function syncSourceRepository(token, repository, desiredLabels, deleteLabe
   for (const existing of existingLabels) {
     const existingKey = normalizeName(existing.name);
 
-    if (desiredKeys.has(existingKey) || !isExactAutoPrunedLabel(existing, deleteLabels)) {
+    if (desiredKeys.has(existingKey) || !isExactGithubDefaultLabel(existing, githubDefaultLabels)) {
       continue;
     }
 
-    deletedConfigured += 1;
-    console.log(`  - ${existing.name} (configured delete)`);
+    deletedGithubDefaults += 1;
+    console.log(`  - ${existing.name} (GitHub default label)`);
 
     if (!dryRun) {
       await githubRequest(
@@ -149,7 +149,7 @@ async function syncSourceRepository(token, repository, desiredLabels, deleteLabe
   for (const existing of existingLabels) {
     const existingKey = normalizeName(existing.name);
 
-    if (desiredKeys.has(existingKey) || isExactAutoPrunedLabel(existing, deleteLabels)) {
+    if (desiredKeys.has(existingKey) || isExactGithubDefaultLabel(existing, githubDefaultLabels)) {
       continue;
     }
 
@@ -166,7 +166,7 @@ async function syncSourceRepository(token, repository, desiredLabels, deleteLabe
   }
 
   console.log(
-    `Summary for ${repository}: created=${created}, updated=${updated}, deletedConfigured=${deletedConfigured}, deletedMissing=${deletedMissing}, unchanged=${unchanged}`,
+    `Summary for ${repository}: created=${created}, updated=${updated}, deletedGithubDefaults=${deletedGithubDefaults}, deletedMissing=${deletedMissing}, unchanged=${unchanged}`,
   );
 }
 
@@ -176,12 +176,12 @@ async function main() {
     defaultSourceRepository: process.env.GITHUB_REPOSITORY ?? "",
   });
   const labels = validateLabels(await readJsonc(labelsPath));
-  const deleteLabels = validateDeleteLabels(await readJsonc(autoPrunedLabelsPath));
+  const githubDefaultLabels = validateGithubDefaultLabels(await readJsonc(githubDefaultLabelsPath));
   const repository = process.env.SOURCE_REPOSITORY ?? properties.sourceRepository;
   assert(repository, "SOURCE_REPOSITORY or properties.sourceRepository is required.");
 
   console.log(
-    `Loaded ${labels.length} managed labels and ${deleteLabels.length} exact auto-pruned label specs for ${repository}.`,
+    `Loaded ${labels.length} managed labels and ${githubDefaultLabels.length} exact GitHub default label specs for ${repository}.`,
   );
 
   if (validateOnly) {
@@ -192,7 +192,7 @@ async function main() {
   const token = process.env.LABEL_SYNC_TOKEN;
   assert(token, "LABEL_SYNC_TOKEN is required unless --validate-only is used.");
 
-  await syncSourceRepository(token, repository, labels, deleteLabels);
+  await syncSourceRepository(token, repository, labels, githubDefaultLabels);
 
   if (dryRun) {
     console.log("Dry-run mode did not apply label changes.");

scripts/sync-config-labels.mjs

@@ -6,12 +6,12 @@ import {
   readJsonc,
   writeJsoncPreservingHeader,
 } from "./lib/config-utils.mjs";
-import { validateDeleteLabels, validateProperties } from "./lib/config-validation.mjs";
+import { validateGithubDefaultLabels, validateProperties } from "./lib/config-validation.mjs";
 
 const workspaceRoot = process.cwd();
 const propertiesPath = path.join(workspaceRoot, "config", "properties.jsonc");
 const labelsPath = path.join(workspaceRoot, "config", "labels.jsonc");
-const autoPrunedLabelsPath = path.join(workspaceRoot, "config", "auto-pruned-labels.jsonc");
+const githubDefaultLabelsPath = path.join(workspaceRoot, "config", "github-default-labels.jsonc");
 
 async function githubRequest(token, method, apiPath) {
   const response = await fetch(`https://api.github.com${apiPath}`, {
@@ -69,14 +69,14 @@ async function main() {
   const repository = process.env.SOURCE_REPOSITORY ?? properties.sourceRepository;
   assert(repository, "SOURCE_REPOSITORY or GITHUB_REPOSITORY is required.");
 
-  const deleteLabels = validateDeleteLabels(await readJsonc(autoPrunedLabelsPath));
+  const githubDefaultLabels = validateGithubDefaultLabels(await readJsonc(githubDefaultLabelsPath));
   const repositoryLabels = await getAllLabels(token, repository);
   const managedLabels = toManagedLabels(repositoryLabels);
 
   await writeJsoncPreservingHeader(labelsPath, managedLabels);
 
   console.log(
-    `Synced ${managedLabels.length} managed labels from ${repository} into config/labels.jsonc. Source labels take precedence over ${deleteLabels.length} exact auto-pruned label specs.`,
+    `Synced ${managedLabels.length} managed labels from ${repository} into config/labels.jsonc. Source labels take precedence over ${githubDefaultLabels.length} exact GitHub default label specs.`,
   );
 }