Add new option to actions.yml

Add new 'include-only-assigned' option
If set, only issues containing assignees will be processed
2025-12-24 01:18:17 +00:00 · 2022-09-12 15:13:07 +00:00 · 2022-09-12 15:13:07 +00:00 · 2022-09-12 15:13:07 +00:00 · 2022-09-12 12:10:27 +00:00 · 2022-09-12 11:17:34 +00:00
8 changed files with 51 additions and 72 deletions
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,22 +1,18 @@
 # Changelog

-# [6.0.0]
-
-:warning: Breaking change :warning:
-
-Issues/PRs default `close-issue-reason` is now `not_planned`([#789](https://github.com/actions/stale/issues/789))
-
 # [5.1.0]

 [Don't process stale issues right after they're marked stale](https://github.com/actions/stale/issues/696)
 [Add close-issue-reason option][#764](https://github.com/actions/stale/pull/764)[#772](https://github.com/actions/stale/pull/772)
 Various dependabot/dependency updates

+
 ## [4.1.0](https://github.com/actions/stale/compare/v3.0.19...v4.1.0) (2021-07-14)

 ## Features

- [Ability to exempt draft PRs](https://github.com/actions/stale/commit/9912fa74d1c01b5d6187793d97441019cbe325d0)
+- [Ability to exempt draft PRs](https://github.com/actions/stale/commit/9912fa74d1c01b5d6187793d97441019cbe325d0
+)

 ## [4.0.0](https://github.com/actions/stale/compare/v3.0.19...v4.0.0) (2021-07-14)

--- a/README.md
+++ b/README.md
@@ -44,7 +44,7 @@ Every argument is optional.
 | [close-pr-message](#close-pr-message)                               | Comment on the staled PRs while closed                                      |                       |
 | [stale-issue-label](#stale-issue-label)                             | Label to apply on staled issues                                             | `Stale`               |
 | [close-issue-label](#close-issue-label)                             | Label to apply on closed issues                                             |                       |
-| [close-issue-reason](#close-issue-reason)                           | Reason to use when closing issues                                           | `not_planned`         |
+| [close-issue-reason](#close-issue-reason)                           | Reason to use when closing issues                                           |                       |
 | [stale-pr-label](#stale-pr-label)                                   | Label to apply on staled PRs                                                | `Stale`               |
 | [close-pr-label](#close-pr-label)                                   | Label to apply on closed PRs                                                |                       |
 | [exempt-issue-labels](#exempt-issue-labels)                         | Labels on issues exempted from stale                                        |                       |
@@ -226,7 +226,7 @@ Required Permission: `issues: write`

 Specify the [reason](https://github.blog/changelog/2022-05-19-the-new-github-issues-may-19th-update/) used when closing issues. Valid values are `completed` and `not_planned`.

-Default value: `not_planned`
+Default value: unset

 #### stale-pr-label

@@ -540,7 +540,7 @@ jobs:
  stale:
    runs-on: ubuntu-latest
    steps:
-      - uses: actions/stale@v6
+      - uses: actions/stale@v5
        with:
          stale-issue-message: 'Message to comment on stale issues. If none provided, will not mark issues stale'
          stale-pr-message: 'Message to comment on stale PRs. If none provided, will not mark PRs stale'
@@ -558,7 +558,7 @@ jobs:
  stale:
    runs-on: ubuntu-latest
    steps:
-      - uses: actions/stale@v6
+      - uses: actions/stale@v5
        with:
          stale-issue-message: 'This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.'
          days-before-stale: 30
@@ -577,7 +577,7 @@ jobs:
  stale:
    runs-on: ubuntu-latest
    steps:
-      - uses: actions/stale@v6
+      - uses: actions/stale@v5
        with:
          stale-issue-message: 'This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.'
          stale-pr-message: 'This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 10 days.'
@@ -599,7 +599,7 @@ jobs:
  stale:
    runs-on: ubuntu-latest
    steps:
-      - uses: actions/stale@v6
+      - uses: actions/stale@v5
        with:
          stale-issue-message: 'This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.'
          stale-pr-message: 'This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 10 days.'
@@ -623,7 +623,7 @@ jobs:
  stale:
    runs-on: ubuntu-latest
    steps:
-      - uses: actions/stale@v6
+      - uses: actions/stale@v5
        with:
          stale-issue-message: 'Stale issue message'
          stale-pr-message: 'Stale pull request message'
@@ -646,7 +646,7 @@ jobs:
  stale:
    runs-on: ubuntu-latest
    steps:
-      - uses: actions/stale@v6
+      - uses: actions/stale@v5
        with:
          start-date: '2020-04-18T00:00:00Z' # ISO 8601 or RFC 2822
 ```
@@ -663,7 +663,7 @@ jobs:
  stale:
    runs-on: ubuntu-latest
    steps:
-      - uses: actions/stale@v6
+      - uses: actions/stale@v5
        with:
          exempt-issue-milestones: 'future,alpha,beta'
          exempt-pr-milestones: 'bugfix,improvement'
@@ -681,7 +681,7 @@ jobs:
  stale:
    runs-on: ubuntu-latest
    steps:
-      - uses: actions/stale@v6
+      - uses: actions/stale@v5
        with:
          exempt-all-pr-milestones: true
 ```
@@ -698,7 +698,7 @@ jobs:
  stale:
    runs-on: ubuntu-latest
    steps:
-      - uses: actions/stale@v6
+      - uses: actions/stale@v5
        with:
          any-of-labels: 'needs-more-info,needs-demo'
          # You can opt for 'only-labels' instead if your use-case requires all labels
@@ -717,7 +717,7 @@ jobs:
  stale:
    runs-on: ubuntu-latest
    steps:
-      - uses: actions/stale@v6
+      - uses: actions/stale@v5
        with:
          exempt-issue-assignees: 'marco,polo'
          exempt-pr-assignees: 'marco'
@@ -735,7 +735,7 @@ jobs:
  stale:
    runs-on: ubuntu-latest
    steps:
-      - uses: actions/stale@v6
+      - uses: actions/stale@v5
        with:
          exempt-all-pr-assignees: true
 ```
--- a/tests/constants/default-processor-options.ts
+++ b/tests/constants/default-processor-options.ts
@@ -1,7 +1,5 @@
 import {IIssuesProcessorOptions} from '../../src/interfaces/issues-processor-options';

-// Default options for use in tests.
-// Mirrors the defaults defined in action.yml
 export const DefaultProcessorOptions: IIssuesProcessorOptions = Object.freeze({
  repoToken: 'none',
  staleIssueMessage: 'This issue is stale',
@@ -53,6 +51,6 @@ export const DefaultProcessorOptions: IIssuesProcessorOptions = Object.freeze({
  ignoreIssueUpdates: undefined,
  ignorePrUpdates: undefined,
  exemptDraftPr: false,
-  closeIssueReason: 'not_planned',
+  closeIssueReason: '',
  includeOnlyAssigned: false
 });
--- a/action.yml
+++ b/action.yml
@@ -51,7 +51,7 @@ inputs:
    required: false
  close-issue-reason:
    description: 'The reason to use when closing an issue.'
-    default: 'not_planned'
+    default: ''
    required: false
  stale-pr-label:
    description: 'The label to apply when a pull request is stale.'
--- a/dist/index.js
+++ b/dist/index.js
@@ -477,9 +477,9 @@ class IssuesProcessor {
                return; // Don't process locked issues
            }
            if (this._isIncludeOnlyAssigned(issue)) {
-                issueLogger.info(`Skipping this $$type because its assignees list is empty`);
+                issueLogger.info(`Skipping this $$type because it's assignees list is empty`);
                IssuesProcessor._endIssueProcessing(issue);
-                return; // If the issue has an 'include-only-assigned' option set, process only issues with nonempty assignees list
+                return; // If the issue has an 'includeOnlyAssigned' option, process only issues with nonempty assignees list
            }
            const onlyLabels = words_to_list_1.wordsToList(this._getOnlyLabels(issue));
            if (onlyLabels.length > 0) {
@@ -2484,6 +2484,7 @@ const file_command_1 = __nccwpck_require__(717);
 const utils_1 = __nccwpck_require__(5278);
 const os = __importStar(__nccwpck_require__(2087));
 const path = __importStar(__nccwpck_require__(5622));
+const uuid_1 = __nccwpck_require__(5840);
 const oidc_utils_1 = __nccwpck_require__(8041);
 /**
 * The code to exit an action
@@ -2513,9 +2514,20 @@ function exportVariable(name, val) {
    process.env[name] = convertedVal;
    const filePath = process.env['GITHUB_ENV'] || '';
    if (filePath) {
-        return file_command_1.issueFileCommand('ENV', file_command_1.prepareKeyValueMessage(name, val));
+        const delimiter = `ghadelimiter_${uuid_1.v4()}`;
+        // These should realistically never happen, but just in case someone finds a way to exploit uuid generation let's not allow keys or values that contain the delimiter.
+        if (name.includes(delimiter)) {
+            throw new Error(`Unexpected input: name should not contain the delimiter "${delimiter}"`);
+        }
+        if (convertedVal.includes(delimiter)) {
+            throw new Error(`Unexpected input: value should not contain the delimiter "${delimiter}"`);
+        }
+        const commandValue = `${name}<<${delimiter}${os.EOL}${convertedVal}${os.EOL}${delimiter}`;
+        file_command_1.issueCommand('ENV', commandValue);
+    }
+    else {
+        command_1.issueCommand('set-env', { name }, convertedVal);
    }
-    command_1.issueCommand('set-env', { name }, convertedVal);
 }
 exports.exportVariable = exportVariable;
 /**
@@ -2533,7 +2545,7 @@ exports.setSecret = setSecret;
 function addPath(inputPath) {
    const filePath = process.env['GITHUB_PATH'] || '';
    if (filePath) {
-        file_command_1.issueFileCommand('PATH', inputPath);
+        file_command_1.issueCommand('PATH', inputPath);
    }
    else {
        command_1.issueCommand('add-path', {}, inputPath);
@@ -2573,10 +2585,7 @@ function getMultilineInput(name, options) {
    const inputs = getInput(name, options)
        .split('\n')
        .filter(x => x !== '');
-    if (options && options.trimWhitespace === false) {
-        return inputs;
-    }
-    return inputs.map(input => input.trim());
+    return inputs;
 }
 exports.getMultilineInput = getMultilineInput;
 /**
@@ -2609,12 +2618,8 @@ exports.getBooleanInput = getBooleanInput;
 */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function setOutput(name, value) {
-    const filePath = process.env['GITHUB_OUTPUT'] || '';
-    if (filePath) {
-        return file_command_1.issueFileCommand('OUTPUT', file_command_1.prepareKeyValueMessage(name, value));
-    }
    process.stdout.write(os.EOL);
-    command_1.issueCommand('set-output', { name }, utils_1.toCommandValue(value));
+    command_1.issueCommand('set-output', { name }, value);
 }
 exports.setOutput = setOutput;
 /**
@@ -2743,11 +2748,7 @@ exports.group = group;
 */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function saveState(name, value) {
-    const filePath = process.env['GITHUB_STATE'] || '';
-    if (filePath) {
-        return file_command_1.issueFileCommand('STATE', file_command_1.prepareKeyValueMessage(name, value));
-    }
-    command_1.issueCommand('save-state', { name }, utils_1.toCommandValue(value));
+    command_1.issueCommand('save-state', { name }, value);
 }
 exports.saveState = saveState;
 /**
@@ -2813,14 +2814,13 @@ var __importStar = (this && this.__importStar) || function (mod) {
    return result;
 };
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.prepareKeyValueMessage = exports.issueFileCommand = void 0;
+exports.issueCommand = void 0;
 // We use any as a valid input type
 /* eslint-disable @typescript-eslint/no-explicit-any */
 const fs = __importStar(__nccwpck_require__(5747));
 const os = __importStar(__nccwpck_require__(2087));
-const uuid_1 = __nccwpck_require__(5840);
 const utils_1 = __nccwpck_require__(5278);
-function issueFileCommand(command, message) {
+function issueCommand(command, message) {
    const filePath = process.env[`GITHUB_${command}`];
    if (!filePath) {
        throw new Error(`Unable to find environment variable for file command ${command}`);
@@ -2832,22 +2832,7 @@ function issueFileCommand(command, message) {
        encoding: 'utf8'
    });
 }
-exports.issueFileCommand = issueFileCommand;
-function prepareKeyValueMessage(key, value) {
-    const delimiter = `ghadelimiter_${uuid_1.v4()}`;
-    const convertedValue = utils_1.toCommandValue(value);
-    // These should realistically never happen, but just in case someone finds a
-    // way to exploit uuid generation let's not allow keys or values that contain
-    // the delimiter.
-    if (key.includes(delimiter)) {
-        throw new Error(`Unexpected input: name should not contain the delimiter "${delimiter}"`);
-    }
-    if (convertedValue.includes(delimiter)) {
-        throw new Error(`Unexpected input: value should not contain the delimiter "${delimiter}"`);
-    }
-    return `${key}<<${delimiter}${os.EOL}${convertedValue}${os.EOL}${delimiter}`;
-}
-exports.prepareKeyValueMessage = prepareKeyValueMessage;
+exports.issueCommand = issueCommand;
 //# sourceMappingURL=file-command.js.map

 /***/ }),
--- a/package-lock.json
+++ b/package-lock.json
@@ -9,7 +9,7 @@
      "version": "2.0.0",
      "license": "MIT",
      "dependencies": {
-        "@actions/core": "^1.10.0",
+        "@actions/core": "^1.2.6",
        "@actions/github": "^5.0.1",
        "lodash.deburr": "^4.1.0",
        "semver": "^7.3.5"
@@ -42,9 +42,9 @@
      }
    },
    "node_modules/@actions/core": {
-      "version": "1.10.0",
-      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.10.0.tgz",
-      "integrity": "sha512-2aZDDa3zrrZbP5ZYg159sNoLRb61nQ7awl5pSvIq5Qpj81vwDzdMRKzkWJGJuwVvWpvZKx7vspJALyvaaIQyug==",
+      "version": "1.9.1",
+      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.9.1.tgz",
+      "integrity": "sha512-5ad+U2YGrmmiw6du20AQW5XuWo7UKN2052FjSV7MX+Wfjf8sCqcsZe62NfgHys4QI4/Y+vQvLKYL8jWtA1ZBTA==",
      "dependencies": {
        "@actions/http-client": "^2.0.1",
        "uuid": "^8.3.2"
@@ -11187,9 +11187,9 @@
  },
  "dependencies": {
    "@actions/core": {
-      "version": "1.10.0",
-      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.10.0.tgz",
-      "integrity": "sha512-2aZDDa3zrrZbP5ZYg159sNoLRb61nQ7awl5pSvIq5Qpj81vwDzdMRKzkWJGJuwVvWpvZKx7vspJALyvaaIQyug==",
+      "version": "1.9.1",
+      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.9.1.tgz",
+      "integrity": "sha512-5ad+U2YGrmmiw6du20AQW5XuWo7UKN2052FjSV7MX+Wfjf8sCqcsZe62NfgHys4QI4/Y+vQvLKYL8jWtA1ZBTA==",
      "requires": {
        "@actions/http-client": "^2.0.1",
        "uuid": "^8.3.2"
--- a/package.json
+++ b/package.json
@@ -38,7 +38,7 @@
  "author": "GitHub",
  "license": "MIT",
  "dependencies": {
-    "@actions/core": "^1.10.0",
+    "@actions/core": "^1.2.6",
    "@actions/github": "^5.0.1",
    "lodash.deburr": "^4.1.0",
    "semver": "^7.3.5"
--- a/src/classes/issues-processor.ts
+++ b/src/classes/issues-processor.ts
@@ -223,10 +223,10 @@ export class IssuesProcessor {

    if (this._isIncludeOnlyAssigned(issue)) {
      issueLogger.info(
-        `Skipping this $$type because its assignees list is empty`
+        `Skipping this $$type because it's assignees list is empty`
      );
      IssuesProcessor._endIssueProcessing(issue);
-      return; // If the issue has an 'include-only-assigned' option set, process only issues with nonempty assignees list
+      return; // If the issue has an 'include-only-assigned' option, process only issues with nonempty assignees list
    }

    const onlyLabels: string[] = wordsToList(this._getOnlyLabels(issue));
Author	SHA1	Message	Date
JoannaaKL	543406b451	Add new option to actions.yml	2022-09-12 15:13:07 +00:00
JoannaaKL	c9c0453c5e	Add new 'include-only-assigned' option If set, only issues containing assignees will be processed	2022-09-12 15:13:07 +00:00
Luke Tomlinson	c750aa3ff8	[Bugfix-795] Fix date comparison edge case (#816 ) * Fix updatedAt and markedStaleOn date comparison * Delete accidental file * Refactor * Cleanup * cleanup	2022-09-12 15:13:07 +00:00
JoannaaKL	e200968421	Add 'include-only-assigned' option to the README	2022-09-12 12:10:27 +00:00
JoannaaKL	8d5a27d5ec	Update index.js with typo fix	2022-09-12 11:17:34 +00:00
JoannaaKL	867763412b	Update src/classes/issues-processor.ts Co-authored-by: Francesco Renzi <rentziass@github.com>	2022-09-12 13:11:53 +02:00
JoannaaKL	13f3458051	Update code comment	2022-09-12 10:01:36 +00:00
JoannaaKL	e878daaea6	Test new flag	2022-09-12 09:44:00 +00:00
JoannaaKL	a1c9a63a3d	Add new 'include-only-assigned' option If set, only issues containing assignees will be processed	2022-09-12 09:42:43 +00:00