Skip to content

docs: fix inaccuracies and language issues in action.yml and README#1337

Open
kranthipoturaju wants to merge 1 commit into
actions:mainfrom
kranthipoturaju:docs/fix-action-yml-and-readme-accuracy
Open

docs: fix inaccuracies and language issues in action.yml and README#1337
kranthipoturaju wants to merge 1 commit into
actions:mainfrom
kranthipoturaju:docs/fix-action-yml-and-readme-accuracy

Conversation

@kranthipoturaju
Copy link
Copy Markdown

Summary

Fixes a collection of inaccuracies, broken syntax, and language issues across action.yml, README.md, and CONTRIBUTING.md. No behavior or logic changes — documentation only.

Changes

action.yml

  • Action name: added "and Pull Requests" — the action processes both, and the omission was inconsistent with the README title
  • repo-token description: fixed broken template expression ({{${{)
  • ignore-updates / ignore-issue-updates / ignore-pr-updates: descriptions were inverted — they described what happens when the option is false (the default), not what enabling it does; rewrote to accurately state that setting to true switches staleness calculation from updated_at to created_at
  • close-issue-reason: documented the two valid values (completed, not_planned) and that an invalid value causes the action to fail (enforced in main.ts)
  • days-before-close / days-before-issue-close / days-before-pr-close / operations-per-run: added "Must be an integer" — all four use parseInt with explicit NaN validation that calls core.setFailed
  • days-before-stale: added note that fractional values are accepted (uses parseFloat)
  • only-issue-labels / only-pr-labels / only-issue-types: corrected default from [] to '' — the actual default is an empty string
  • sort-by: documented that unrecognised values silently fall back to created rather than erroring
  • start-date: documented that an invalid date format fails the action
  • exempt-draft-pr: corrected stale note — since June 2022 the draft flag is read from the issue list payload; no additional API call is made
  • exempt-all-milestones / exempt-all-assignees: normalised "Default to false" → "Defaults to false"
  • Outputs: corrected type from "List" to "JSON array" (values are JSON.stringify-encoded); reordered to match declaration order in main.ts
  • Grammar: "closing a pull requests" → "closing a pull request"

README.md

  • Fixed Node.js version references: node20 / node 24Node.js 20 / Node.js 24 (canonical branding)
  • Fixed hyphenation: comma separatedcomma-separated in five option descriptions (compound modifier rule)
  • Fixed subject-verb agreement: consumeconsumes, displaydisplays
  • Fixed conditional tense: If you reached the limitIf you reach the limit

CONTRIBUTING.md

  • Fixed canonical branding: typescriptTypeScript
  • Fixed grammar: a bump of version will happenthe version will be bumped
  • Fixed punctuation: added missing comma in Otherwise, PR checks will fail.

Impact

  • Users: more accurate action.yml descriptions surface in the GitHub Actions UI and autocomplete, reducing misconfiguration
  • ignore-updates fix: the corrected description may change how users understand and set this option — previously the description implied the opposite of what true does
  • Backward compatibility: no inputs, outputs, or defaults were changed; all modifications are description/documentation only

Testing

These are documentation-only changes with no executable code modifications.
Verified by cross-referencing each description against the corresponding core.getInput call in src/main.ts, the IIssuesProcessorOptions interface, and the processing logic in src/classes/issues-processor.ts.

Related issue:
No issue was created as the changes are documentation only changes.

Check list:

  • Mark if documentation changes are required.
  • Mark if tests were added or updated to cover the changes.

Copilot AI review requested due to automatic review settings May 7, 2026 15:41
@kranthipoturaju kranthipoturaju requested a review from a team as a code owner May 7, 2026 15:41
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates documentation and metadata text for the stale action to better match current behavior and improve wording/grammar across the repository.

Changes:

  • Updates action.yml input/output descriptions (syntax fixes, clarified semantics, and normalized phrasing).
  • Fixes wording and branding/grammar issues in README.md and CONTRIBUTING.md.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.

File Description
action.yml Refines action name plus multiple input/output descriptions shown in the GitHub Actions UI.
README.md Fixes wording/grammar in a few option descriptions and the v10 breaking change note.
CONTRIBUTING.md Fixes branding and minor grammar/punctuation in contributor instructions.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
Comment on lines 520 to +521
If set to `true`, the pull requests currently in draft will not be marked as stale automatically.
⚠️ This option consume one operation per pull request to process because we need to fetch the pull request with the GitHub API to know if it's a draft one or not.
⚠️ This option consumes one operation per pull request to process because we need to fetch the pull request with the GitHub API to know if it's a draft one or not.
Comment thread action.yml
Comment on lines 31 to 34
days-before-close:
description: 'The number of days to wait to close an issue or a pull request after it being marked stale. Set to -1 to never close stale issues or pull requests.'
description: 'The number of days to wait to close an issue or a pull request after it being marked stale. Must be an integer. Set to -1 to never close stale issues or pull requests.'
required: false
default: '7'
Comment thread action.yml
Comment on lines 35 to 40
days-before-issue-close:
description: 'The number of days to wait to close an issue after it being marked stale. Set to -1 to never close stale issues. Override "days-before-close" option regarding only the issues.'
description: 'The number of days to wait to close an issue after it being marked stale. Must be an integer. Set to -1 to never close stale issues. Override "days-before-close" option regarding only the issues.'
required: false
days-before-pr-close:
description: 'The number of days to wait to close a pull request after it being marked stale. Set to -1 to never close stale pull requests. Override "days-before-close" option regarding only the pull requests.'
description: 'The number of days to wait to close a pull request after it being marked stale. Must be an integer. Set to -1 to never close stale pull requests. Override "days-before-close" option regarding only the pull requests.'
required: false
Comment thread action.yml
required: false
operations-per-run:
description: 'The maximum number of operations per run, used to control rate limiting (GitHub API CRUD related).'
description: 'The maximum number of operations per run, used to control rate limiting (GitHub API CRUD related). Must be an integer.'
Comment thread action.yml
Comment on lines 211 to 214
only-issue-types:
description: 'Only issues with a matching type are processed as stale/closed. Defaults to `[]` (disabled) and can be a comma-separated list of issue types.'
default: ''
required: false
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants