Remove labels on stale (#959)

actions · Mar 21, 2023 · 75d4d95 · 75d4d95
1 parent 01aa532
commit 75d4d95
Show file tree

Hide file tree

Showing 11 changed files with 1,398 additions and 1,315 deletions.
diff --git a/README.md b/README.md
@@ -63,6 +63,7 @@ Every argument is optional.
 | [remove-issue-stale-when-updated](#remove-issue-stale-when-updated) | Remove stale label from issues on updates/comments                          |                       |
 | [remove-pr-stale-when-updated](#remove-pr-stale-when-updated)       | Remove stale label from PRs on updates/comments                             |                       |
 | [labels-to-add-when-unstale](#labels-to-add-when-unstale)           | Add specified labels from issues/PRs when they become unstale               |                       |
+| [labels-to-remove-when-stale](#labels-to-remove-when-stale)         | Remove specified labels from issues/PRs when they become stale              |                       |
 | [labels-to-remove-when-unstale](#labels-to-remove-when-unstale)     | Remove specified labels from issues/PRs when they become unstale            |                       |
 | [debug-only](#debug-only)                                           | Dry-run                                                                     | `false`               |
 | [ascending](#ascending)                                             | Order to get issues/PRs                                                     | `false`               |
@@ -358,6 +359,15 @@ A comma delimited list of labels to add when a stale issue or pull request recei
 
 Default value: unset
 
+#### labels-to-remove-when-stale
+
+A comma delimited list of labels to remove when an issue or pull request becomes stale and has the [stale-issue-label](#stale-issue-label) or [stale-pr-label](#stale-pr-label) added to it.
+
+Warning: each label results in a unique API call which can drastically consume the limit of [operations-per-run](#operations-per-run).
+
+Default value: unset  
+Required Permission: `pull-requests: write`
+
 #### labels-to-remove-when-unstale
 
 A comma delimited list of labels to remove when a stale issue or pull request receives activity and has the [stale-issue-label](#stale-issue-label) or [stale-pr-label](#stale-pr-label) removed from it.

diff --git a/__tests__/constants/default-processor-options.ts b/__tests__/constants/default-processor-options.ts
@@ -47,6 +47,7 @@ export const DefaultProcessorOptions: IIssuesProcessorOptions = Object.freeze({
   exemptAllIssueAssignees: undefined,
   exemptAllPrAssignees: undefined,
   enableStatistics: true,
+  labelsToRemoveWhenStale: '',
   labelsToRemoveWhenUnstale: '',
   labelsToAddWhenUnstale: '',
   ignoreUpdates: false,

diff --git a/__tests__/main.spec.ts b/__tests__/main.spec.ts
@@ -1220,6 +1220,48 @@ test('when the option "labelsToAddWhenUnstale" is set, the labels should be adde
   expect(processor.addedLabelIssues).toHaveLength(1);
 });
 
+test('when the option "labelsToRemoveWhenStale" is set, the labels should be removed when stale', async () => {
+  expect.assertions(3);
+  const opts = {
+    ...DefaultProcessorOptions,
+    removeStaleWhenUpdated: true,
+    labelsToRemoveWhenStale: 'test'
+  };
+  const TestIssueList: Issue[] = [
+    generateIssue(
+      opts,
+      1,
+      'An issue that should have labels removed to it when stale',
+      '2020-01-01T17:00:00Z',
+      '2020-01-01T17:00:00Z',
+      false,
+      ['Stale', 'test']
+    )
+  ];
+  const processor = new IssuesProcessorMock(
+    opts,
+    async p => (p === 1 ? TestIssueList : []),
+    async () => [
+      {
+        user: {
+          login: 'notme',
+          type: 'User'
+        },
+        body: 'Body'
+      }
+    ], // return a fake comment to indicate there was an update
+    async () => new Date().toDateString()
+  );
+
+  // process our fake issue list
+  await processor.processIssues(1);
+
+  expect(processor.closedIssues).toHaveLength(0);
+  expect(processor.staleIssues).toHaveLength(0);
+  // test label should have been removed
+  expect(processor.removedLabelIssues).toHaveLength(1);
+});
+
 test('stale label should not be removed if a comment was added by the bot (and the issue should be closed)', async () => {
   const opts = {...DefaultProcessorOptions, removeStaleWhenUpdated: true};
   github.context.actor = 'abot';

diff --git a/action.yml b/action.yml
@@ -177,11 +177,15 @@ inputs:
     default: 'true'
     required: false
   labels-to-add-when-unstale:
-    description: 'A comma delimited list of labels to add when a stale issue or pull request receives activity and has the stale-issue-label or stale-pr-label removed from it.'
+    description: 'A comma delimited list of labels to add when an issue or pull request becomes unstale.'
+    default: ''
+    required: false
+  labels-to-remove-when-stale:
+    description: 'A comma delimited list of labels to remove when an issue or pull request becomes stale.'
     default: ''
     required: false
   labels-to-remove-when-unstale:
-    description: 'A comma delimited list of labels to remove when a stale issue or pull request receives activity and has the stale-issue-label or stale-pr-label removed from it.'
+    description: 'A comma delimited list of labels to remove when an issue or pull request becomes unstale.'
     default: ''
     required: false
   ignore-updates: