Merge branch 'main' into rybickic/upgrade-assignees

projen · Mar 17, 2022 · f9e5489 · f9e5489
2 parents 555bc64 + 06123c9
commit f9e5489
Show file tree

Hide file tree

Showing 28 changed files with 167 additions and 1,295 deletions.
diff --git a/.gitattributes b/.gitattributes
diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml
diff --git a/.gitignore b/.gitignore
diff --git a/.projen/files.json b/.projen/files.json
diff --git a/docs/api/API.md b/docs/api/API.md
diff --git a/docs/github.md b/docs/github.md
@@ -4,10 +4,36 @@ By default, many projects are initialized with `GitHub` component to enabled Git
 
 The use of GitHub (and generating corresponding files in `.github`) can be disabled by specifying `github: false` in your project options.
 
-### Workflows
+## Workflows
 
 TODO
 
 See the `GitHub`, `GithubWorkflow`, and `Job` types in the [API reference](./api/API.md) for currently available APIs.
 
 Example code of creating a GitHub workflow: <https://github.com/projen/projen/blob/65b4194c163f47ba4842981b0c92dbe516be787b/src/github/auto-approve.ts#L67-L105>
+
+### Stale workflow
+
+A "stale" workflow can be added which will automatically close issues or pull
+requests on your GitHub repository after time has passed without the issue
+seeing any comments or updates. You can enable as shown below:
+
+```ts
+// or PythonProject, etc.
+new typescript.TypeScriptProject({
+  stale: true,
+  staleOptions: {
+    issues: {
+      closeMessage: "closing pull request",
+      staleLabel: "I-AM-STALE",
+      daysBeforeStale: 180,
+    },
+  }
+})
+```
+
+Check the API reference for a list of all available options.
+
+When enabled, by default issues with no activity with will be marked as stale
+after 60 days and closed within 7 days, and pull requests with no activity will
+be marked as stale after 14 days and closed within 2 days.
diff --git a/package.json b/package.json
diff --git a/src/github/github-project.ts b/src/github/github-project.ts
@@ -118,7 +118,7 @@ export interface GitHubProjectOptions extends ProjectOptions {
   /**
    * Auto-close of stale issues and pull request. See `staleOptions` for options.
    *
-   * @default true
+   * @default false
    */
   readonly stale?: boolean;
 
@@ -218,7 +218,7 @@ export class GitHubProject extends Project {
       );
     }
 
-    const stale = options.stale ?? true;
+    const stale = options.stale ?? false;
     if (stale && this.github) {
       new Stale(this.github, options.staleOptions);
     }

diff --git a/test/__snapshots__/cleanup.test.ts.snap b/test/__snapshots__/cleanup.test.ts.snap