From c500ddf5e454bfe389b15ba15d0e69a371e4106f Mon Sep 17 00:00:00 2001 From: Andy Jordan <2226434+andyleejordan@users.noreply.github.com> Date: Thu, 16 Nov 2023 14:50:51 -0800 Subject: [PATCH] Update issue forms and add `actions/stale` Tested in vscode-powershell first, this should help a ton. --- .github/ISSUE_TEMPLATE/bug-report.yml | 88 ++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 + .github/ISSUE_TEMPLATE/feature-request.yml | 26 ++++ .github/dependabot.yml | 2 + .github/policies/resourceManagement.yml | 150 --------------------- .github/workflows/close-stale-issues.yml | 35 +++++ .github/workflows/codeql-analysis.yml | 2 +- 7 files changed, 157 insertions(+), 151 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml delete mode 100644 .github/policies/resourceManagement.yml create mode 100644 .github/workflows/close-stale-issues.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 000000000..833e11523 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,88 @@ +name: 🐛 Bug report +description: Open an issue about a bug that needs fixing. +labels: ["Issue-Bug", "Needs: Triage"] +body: +- type: checkboxes + attributes: + label: Prerequisites + options: + - label: I have written a descriptive issue title. + required: true + - label: I have searched all [_open and closed_ issues](https://github.com/PowerShell/PowerShellEditorServices/issues?q=is%3Aissue) to ensure it has not already been reported. + - label: I have read the [troubleshooting](https://github.com/PowerShell/vscode-powershell/blob/main/docs/troubleshooting.md) guide. + - label: I am sure this issue is with _PowerShell Editor Services itself_ and does not reproduce in a standalone [PowerShell](https://github.com/PowerShell/PowerShell/issues/new/choose) instance, and is not an issue with my editor. + - label: I have verified that I am using the latest version of PowerShell Editor Services. + - label: If this is a security issue, I have read the [security issue reporting guidance](https://github.com/PowerShell/vscode-powershell/blob/main/SECURITY.md). +- type: textarea + id: summary + attributes: + label: Summary + description: Explain the problem briefly below. + placeholder: I am experiencing a problem with X. I think Y should be happening but Z is actually happening. + validations: + required: true +- type: textarea + id: powershell-version + attributes: + label: PowerShell Version + description: Paste verbatim output from `$PSVersionTable` below. Please double-check that this is the PowerShell version that is running Editor Services. + render: console + placeholder: | + PS> $PSVersionTable + + Name Value + ---- ----- + PSVersion 7.4.0 + PSEdition Core + GitCommitId 7.4.0 + OS Darwin 20.4.0 Darwin Kernel + Platform Unix + PSCompatibleVersions {1.0, 2.0, 3.0, 4.0…} + PSRemotingProtocolVersion 2.3 + SerializationVersion 1.1.0.1 + WSManStackVersion 3.0 + validations: + required: true +- type: textarea + id: vscode-version + attributes: + label: Editor Version + description: Paste verbatim output from `emacs --version` or `vim --version` etc. below. **Please also describe how you setup the relevant LSP client, such as `eglot` or `vim-lsp` and share your configuration!** + render: console + placeholder: | + PS> emacs --version + GNU Emacs 29.1 + ... + validations: + required: true +- type: textarea + id: extension-version + attributes: + label: PowerShell Editor Services Version + description: If you have interactive access to the PowerShell host running Editor Services, paste verbatim output of `$psEditor.EditorServicesVersion` below. + render: console + placeholder: | + PS> $psEditor.EditorServicesVersion + + Major Minor Build Revision + ----- ----- ----- -------- + 3 14 0 0 + validations: + required: true +- type: textarea + id: steps-to-reproduce + attributes: + label: Steps to Reproduce + description: List of steps, sample code, failing test or link to a project that reproduces the behavior. Make sure you place a stack trace inside a code (```) block to avoid linking unrelated issues. + validations: + required: true +- type: textarea + id: visuals + attributes: + label: Visuals + description: Please upload images or animations that can be used to reproduce issues in the area below. Try the [Steps Recorder](https://support.microsoft.com/en-us/windows/record-steps-to-reproduce-a-problem-46582a9b-620f-2e36-00c9-04e25d784e47) on Windows or [Screenshot](https://support.apple.com/en-us/HT208721) on macOS. +- type: textarea + id: logs + attributes: + label: Logs + description: Please upload logs collected by following these [instructions](https://github.com/PowerShell/vscode-powershell/blob/main/docs/troubleshooting.md#logs) for VS Code (otherwise however your editor is setup) in the area below. Be careful to scrub sensitive information! diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..f3be2597d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: 🙋 Ask a question + url: https://aka.ms/powershell-vscode-discord + about: "Find us in #vscode on the PowerShell Community Discord" diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 000000000..903c2483d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,26 @@ +name: ✨ Feature request +description: Open an issue about a potential new feature or improvement. +labels: ["Issue-Enhancement", "Needs: Triage"] +body: +- type: checkboxes + attributes: + label: Prerequisites + options: + - label: I have written a descriptive issue title. + required: true + - label: I have searched all [issues](https://github.com/PowerShell/PowerShellEditorServices/issues?q=is%3Aissue) to ensure it has not already been requested. + required: true +- type: textarea + id: summary + attributes: + label: Summary + description: Explain the feature request below. + placeholder: I would like to do X because it would be useful for Y and I cannot currently do it with Z. + validations: + required: true +- type: textarea + id: proposed-design + attributes: + label: Proposed Design + description: Optionally explain any technical design below. + placeholder: We could accomplish this by extending X to take Y and yield Z. diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 4d3cb79e4..e3a2fb57f 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -2,6 +2,7 @@ version: 2 updates: - package-ecosystem: nuget directory: "/" + labels: [ ] schedule: interval: weekly open-pull-requests-limit: 10 @@ -15,5 +16,6 @@ updates: - "xunit.*" - package-ecosystem: github-actions directory: "/" + labels: [ ] schedule: interval: weekly diff --git a/.github/policies/resourceManagement.yml b/.github/policies/resourceManagement.yml deleted file mode 100644 index 0028f166f..000000000 --- a/.github/policies/resourceManagement.yml +++ /dev/null @@ -1,150 +0,0 @@ -id: -name: GitOps.PullRequestIssueManagement -description: GitOps.PullRequestIssueManagement primitive -owner: -resource: repository -disabled: false -where: -configuration: - resourceManagementConfiguration: - scheduledSearches: - - description: - frequencies: - - hourly: - hour: 3 - filters: - - isIssue - - isOpen - - hasLabel: - label: "Needs: Author Feedback \U0001F442" - - noActivitySince: - days: 8 - actions: - - closeIssue - - addReply: - reply: This issue was closed automatically as author feedback was indicated as needed, but there has been no activity in over a week. Please feel free to reopen with any available information! - - description: - frequencies: - - hourly: - hour: 3 - filters: - - isIssue - - isOpen - - hasLabel: - label: Resolution-Duplicate - - noActivitySince: - days: 1 - actions: - - addReply: - reply: This issue has been marked as duplicate and has not had any activity in a day. It has been closed for housekeeping purposes. - - closeIssue - - description: - frequencies: - - hourly: - hour: 3 - filters: - - isOpen - - hasLabel: - label: Resolution-Answered - - noActivitySince: - days: 1 - actions: - - closeIssue - - addReply: - reply: This issue has been marked as answered and has not had any activity in a day. It has been automatically closed for housekeeping purposes. - - description: - frequencies: - - hourly: - hour: 3 - filters: - - isOpen - - hasLabel: - label: Needs-Repro-Info - - noActivitySince: - days: 8 - actions: - - addReply: - reply: This issue was closed automatically as repro info was indicated as needed, but there has been no activity in over a week. Please feel free to reopen with any available information! - - closeIssue - - description: - frequencies: - - hourly: - hour: 3 - filters: - - isOpen - - hasLabel: - label: Resolution-External - actions: - - closeIssue - - addReply: - reply: This issue has been marked as external. It has been automatically closed for housekeeping purposes. - - description: - frequencies: - - hourly: - hour: 3 - filters: - - isOpen - - hasLabel: - label: 'Status: Fixed' - actions: - - closeIssue - - addReply: - reply: This issue has been marked as fixed. It has been automatically closed for housekeeping purposes. - - description: - frequencies: - - hourly: - hour: 3 - filters: - - isOpen - - hasLabel: - label: Resolution-Inactive - actions: - - addReply: - reply: This issue has been marked as inactive. It has been automatically closed for housekeeping purposes. - - closeIssue - eventResponderTasks: - - if: - - payloadType: Issue_Comment - - isAction: - action: Created - - hasLabel: - label: "Needs: Author Feedback \U0001F442" - - isActivitySender: - issueAuthor: True - then: - - addLabel: - label: 'Needs: Attention :wave:' - - removeLabel: - label: "Needs: Author Feedback \U0001F442" - description: - - if: - - payloadType: Pull_Request - then: - - labelSync: - pattern: Issue-* - - labelSync: - pattern: Area-* - description: - - if: - - payloadType: Issue_Comment - - not: isOpen - - isAction: - action: Created - - hasLabel: - label: "Needs: Author Feedback \U0001F442" - - isActivitySender: - issueAuthor: True - then: - - reopenIssue - - removeLabel: - label: "Needs: Author Feedback \U0001F442" - - addLabel: - label: 'Needs: Attention :wave:' - description: - - if: - - payloadType: Issue_Comment - then: - - cleanEmailReply - description: -onFailure: -onSuccess: diff --git a/.github/workflows/close-stale-issues.yml b/.github/workflows/close-stale-issues.yml new file mode 100644 index 000000000..2df3ade91 --- /dev/null +++ b/.github/workflows/close-stale-issues.yml @@ -0,0 +1,35 @@ +name: Close Stale Issues + +permissions: + issues: write + +on: + schedule: + - cron: "*/15 * * * *" + +jobs: + stale-resolved-issues: + runs-on: ubuntu-latest + steps: + - uses: actions/stale@v8 + name: Close issues labeled as resolved after 1 day of inactivity + with: + any-of-labels: "Resolution-Answered,Resolution-Duplicate,Resolution-External,Resolution-Fixed,Resolution-Inactive" + days-before-stale: 1 + days-before-close: 0 + close-issue-reason: completed + close-issue-message: "This issue has been labeled as resolved and has not had any activity for one or more days. It has been closed for housekeeping purposes." + stale-feedback-issues: + runs-on: ubuntu-latest + steps: + - uses: actions/stale@v8 + name: Close issues labeled as needs feedback after 1 week of inactivity + with: + any-of-labels: "Needs: Author Feedback,Needs: Fix Verification,Needs: Repro Info" + days-before-stale: 2 + days-before-close: 5 + labels-to-remove-when-stale: "Needs: Maintainer Attention" + labels-to-add-when-unstale: "Needs: Maintainer Attention" + labels-to-remove-when-unstale: "Needs: Author Feedback,Needs: Fix Verification,Needs: Repro Info" + close-issue-reason: completed + close-issue-message: "This issue has been labeled as needing feedback and has not had any activity for one or more weeks. It has been closed for housekeeping purposes." diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index 8f174da10..8e7533a0d 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -1,4 +1,4 @@ -name: "CodeQL" +name: Run CodeQL Analysis on: push: