chore: disable stale workflow by default (projen#1689)

After talking with others and reviewing its impact on contributors of different GitHub projects, it feels like enabling the stale workflow may not be the right default for all projects. This PR changes the default to not adding it, so it's now opt-in. BREAKING CHANGE: `stale.yml` GitHub workflow is no longer generated as the default behavior in projects. To keep generating it, specify `stale: true` or initialize a `github.Stale` component directly. --- By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
FitX · Mar 17, 2022 · 06123c9 · 06123c9
1 parent edd0088
commit 06123c9
Show file tree

Hide file tree

Showing 26 changed files with 98 additions and 1,226 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/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
diff --git a/test/__snapshots__/integ.test.ts.snap b/test/__snapshots__/integ.test.ts.snap