Update README.md

Example runs once per day instead of per hour

README.md

@@ -7,11 +7,11 @@ Warns and then closes issues and PRs that have had no activity for a specified a
 See [action.yml](./action.yml) For comprehensive list of options.
  
 Basic:
-```
+```yaml
 name: "Close stale issues"
 on:
   schedule:
-  - cron: "0 * * * *"
+  - cron: "0 0 * * *"
 
 jobs:
   stale:
@@ -25,11 +25,11 @@ jobs:
 ```
  
 Configure stale timeouts:
-```
+```yaml
 name: "Close stale issues"
 on:
   schedule:
-  - cron: "0 * * * *"
+  - cron: "0 0 * * *"
 
 jobs:
   stale:
@@ -44,11 +44,11 @@ jobs:
 ```
  
 Configure labels:
-```
+```yaml
 name: "Close stale issues"
 on:
   schedule:
-  - cron: "0 * * * *"
+  - cron: "0 0 * * *"
 
 jobs:
   stale:
@@ -60,5 +60,7 @@ jobs:
         stale-issue-message: 'Stale issue message'
         stale-pr-message: 'Stale issue message'
         stale-issue-label: 'no-issue-activity'
+        exempt-issue-label: 'awaiting-approval'
         stale-pr-label: 'no-pr-activity'
+        exempt-pr-label: 'awaiting-approval'
 ```

action.yml

@@ -6,24 +6,28 @@ inputs:
     description: 'Token for the repo. Can be passed in using {{ secrets.GITHUB_TOKEN }}'
     required: true
   stale-issue-message:
-    description: 'The message to post on the issue when tagging it. If none provided, will not mark iusses stale.'
+    description: 'The message to post on the issue when tagging it. If none provided, will not mark issues stale.'
   stale-pr-message:
-    description: 'The message to post on the pr when tagging it. If none provided, will not mark prs stale.'
+    description: 'The message to post on the pr when tagging it. If none provided, will not mark pull requests stale.'
   days-before-stale:
     description: 'The number of days old an issue can be before marking it stale'
     default: 60
   days-before-close:
-    description: 'The number of days to wait to close an issue or pr after it being marked stale'
+    description: 'The number of days to wait to close an issue or pull request after it being marked stale'
     default: 7
   stale-issue-label:
     description: 'The label to apply when an issue is stale'
     default: 'Stale'
+  exempt-issue-label:
+    description: 'The label to apply when an issue is exempt from being marked stale'
   stale-pr-label:
-    description: 'The label to apply when a pr is stale'
+    description: 'The label to apply when a pull request is stale'
     default: 'Stale'
+  exempt-pr-label:
+    description: 'The label to apply when a pull request is exempt from being marked stale'
   operations-per-run:
     description: 'The maximum number of operations per run, used to control rate limiting'
     default: 30
 runs:
   using: 'node12'
-  main: 'lib/main.js'
+  main: 'lib/main.js'

package.json

@@ -12,12 +12,12 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/actions/start-vm-action.git"
+    "url": "git+https://github.com/actions/stale.git"
   },
   "keywords": [
     "actions",
     "node",
-    "setup"
+    "stale"
   ],
   "author": "GitHub",
   "license": "MIT",

src/main.ts

@@ -2,6 +2,9 @@ import * as core from '@actions/core';
 import * as github from '@actions/github';
 import * as Octokit from '@octokit/rest';
 
+type Issue = Octokit.IssuesListForRepoResponseItem;
+type IssueLabel = Octokit.IssuesListForRepoResponseItemLabelsItem;
+
 type Args = {
   repoToken: string;
   staleIssueMessage: string;
@@ -9,7 +12,9 @@ type Args = {
   daysBeforeStale: number;
   daysBeforeClose: number;
   staleIssueLabel: string;
+  exemptIssueLabel: string;
   stalePrLabel: string;
+  exemptPrLabel: string;
   operationsPerRun: number;
 };
 
@@ -51,13 +56,16 @@ async function processIssues(
 
     let staleMessage = isPr ? args.stalePrMessage : args.staleIssueMessage;
     if (!staleMessage) {
-      core.debug(`skipping ${isPr ? "pr" : "issue"} due to empty message`);
+      core.debug(`skipping ${isPr ? 'pr' : 'issue'} due to empty message`);
       continue;
     }
 
     let staleLabel = isPr ? args.stalePrLabel : args.staleIssueLabel;
+    let exemptLabel = isPr ? args.exemptPrLabel : args.exemptIssueLabel;
 
-    if (isLabeledStale(issue, staleLabel)) {
+    if (exemptLabel && isLabeled(issue, exemptLabel)) {
+      continue;
+    } else if (isLabeled(issue, staleLabel)) {
       if (wasLastUpdatedBefore(issue, args.daysBeforeClose)) {
         operationsLeft -= await closeIssue(client, issue);
       } else {
@@ -82,20 +90,14 @@ async function processIssues(
   return await processIssues(client, args, operationsLeft, page + 1);
 }
 
-function isLabeledStale(
+function isLabeled(issue: Issue, label: string): boolean {
-  issue: Octokit.IssuesListForRepoResponseItem,
+  const labelComparer: (l: IssueLabel) => boolean = l =>
-  label: string
+    label.localeCompare(l.name, undefined, {sensitivity: 'accent'}) === 0;
-): boolean {
-  const labelComparer = l =>
-    label.localeCompare(l.name, undefined, {sensitivity: 'accent'});
   return issue.labels.filter(labelComparer).length > 0;
 }
 
-function wasLastUpdatedBefore(
+function wasLastUpdatedBefore(issue: Issue, num_days: number): boolean {
-  issue: Octokit.IssuesListForRepoResponseItem,
+  const daysInMillis = 1000 * 60 * 60 * 24 * num_days;
-  num_days: number
-): boolean {
-  const daysInMillis = 1000 * 60 * 60 * num_days;
   const millisSinceLastUpdated =
     new Date().getTime() - new Date(issue.updated_at).getTime();
   return millisSinceLastUpdated >= daysInMillis;
@@ -103,7 +105,7 @@ function wasLastUpdatedBefore(
 
 async function markStale(
   client: github.GitHub,
-  issue: Octokit.IssuesListForRepoResponseItem,
+  issue: Issue,
   staleMessage: string,
   staleLabel: string
 ): Promise<number> {
@@ -128,7 +130,7 @@ async function markStale(
 
 async function closeIssue(
   client: github.GitHub,
-  issue: Octokit.IssuesListForRepoResponseItem
+  issue: Issue
 ): Promise<number> {
   core.debug(`closing issue ${issue.title} for being stale`);
 
@@ -154,7 +156,9 @@ function getAndValidateArgs(): Args {
       core.getInput('days-before-close', {required: true})
     ),
     staleIssueLabel: core.getInput('stale-issue-label', {required: true}),
+    exemptIssueLabel: core.getInput('exempt-issue-label'),
     stalePrLabel: core.getInput('stale-pr-label', {required: true}),
+    exemptPrLabel: core.getInput('exempt-pr-label'),
     operationsPerRun: parseInt(
       core.getInput('operations-per-run', {required: true})
     )