From c3347d94abe131f4e75ef3d9736184715f471812 Mon Sep 17 00:00:00 2001 From: schroda <50052685+schroda@users.noreply.github.com> Date: Sun, 23 Mar 2025 00:35:08 +0100 Subject: [PATCH] Feature/use GitHub issue yml format (#1314) * Update github issue templates to yml format * Remove "issue moderator" workflow * Require more client info for "bug issues" - client name - client version --- .github/ISSUE_TEMPLATE/bug_report.md | 44 ------- .github/ISSUE_TEMPLATE/bug_report.yml | 144 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 29 ----- .github/ISSUE_TEMPLATE/feature_request.yml | 37 ++++++ .github/workflows/issue_moderator.yml | 44 ------- 5 files changed, 181 insertions(+), 117 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml delete mode 100644 .github/workflows/issue_moderator.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index a314ce3ee..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -name: "🐞 Bug report" -title: "[Bug] " -about: "Report a bug" -labels: "bug" ---- - -**PLEASE READ THIS** - -I acknowledge that: - -- I have updated to the latest version of the app. -- I have tried the troubleshooting guide described in `README.md` -- If this is a request for adding/changing an extension it should be brought up to your extension repo. -- If this is an issue with some extension not working properly, It does work inside Tachiyomi as intended. -- I have searched the existing issues and this is a new ticket **NOT** a duplicate or related to another open issue -- I will fill out the title and the information in this template - -Note that the issue will be automatically closed if you do not fill out the title or requested information. - -**DELETE THIS SECTION IF YOU HAVE READ AND ACKNOWLEDGED IT** - ---- - -## Device information -- Suwayomi-Server version: (Example: v1.1.1-r1535-win32) -- Server Operating System: (Example: Ubuntu 20.04) -- Server Desktop Environment: N/A or (Example: Gnome 40) -- Server JVM version: bundled with win32 or (Example: Java 21.0.5 or Temurin 21.0.5) -- Client Operating System: -- Client Web Browser: (Example: Google Chrome 89.0.4389.82) - -## Steps to reproduce -1. First Step -2. Second Step - -### Expected behavior -Describe what should have happened. Remove this line after you are done. - -### Actual behavior -Describe what happens instead. Remove this line after you are done. - -## Other details -Describe additional details If necessary. Remove this line after you are done. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..1aae338f5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,144 @@ +name: 🐞 Bug report +description: Report a bug in Suwayomi-Server +labels: [bug] +body: + + - type: textarea + id: reproduce-steps + attributes: + label: Steps to reproduce + description: Provide an example of the issue. + placeholder: | + Example: + 1. First step + 2. Second step + 3. Issue here + validations: + required: true + + - type: textarea + id: expected-behavior + attributes: + label: Expected behavior + description: Explain what you should expect to happen. + placeholder: | + Example: "This should happen..." + validations: + required: true + + - type: textarea + id: actual-behavior + attributes: + label: Actual behavior + description: Explain what actually happens. + placeholder: | + Example: "This happened instead..." + validations: + required: true + + - type: input + id: suwayomi-server-version + attributes: + label: Suwayomi-Server version + description: You can find your Suwayomi-Server version in **More → About**. + placeholder: | + Example: "v1.1.1 | v1.1.1-r1701" + validations: + required: true + + - type: input + id: server-os + attributes: + label: Server operating system + description: The operating system on which Suwayomi-Server is running on + placeholder: | + Example: "Windows 11 Pro 24H2 | Ubuntu 24.04.2 LTS" + validations: + required: true + + - type: input + id: server-desktop-environment + attributes: + label: Server Desktop Environment + description: + placeholder: | + Example: "Gnome 40" + validations: + required: false + + - type: input + id: server-jvm-version + attributes: + label: Server JVM version + description: The java version used to run Suwayomi-Server + placeholder: | + Example: "openjdk 21.0.5 2024-10-15 LTS" + validations: + required: true + + - type: input + id: client-name + attributes: + label: Used client name + description: + placeholder: | + Example: "Suwayomi-WebUI" + validations: + required: true + + - type: input + id: client-version + attributes: + label: Client version + description: + placeholder: | + Example: "v1.2.3" + validations: + required: true + + - type: input + id: client-browser + attributes: + label: Used web browser + description: The browser which is used to open Suwayomi-WebUI + placeholder: | + Example: "Chrome 134.0.6998.118 (64-Bit) | FireFox 136.0.2 (64-Bit) | Electron v35.0.2" + validations: + required: true + + - type: input + id: client-os + attributes: + label: Client operating system + description: The system on which the Suwayomi-WebUI is running on + placeholder: | + Example: "Windows 11 Pro 24H2 | Ubuntu 24.04.2 LTS" + validations: + required: true + + - type: textarea + id: other-details + attributes: + label: Other details + description: The more information that gets provided the better, especially via videos and images + placeholder: | + Additional details and attachments. + + - type: checkboxes + id: acknowledgements + attributes: + label: Acknowledgements + description: Read this carefully, we will close and ignore your issue if you skimmed through this. + options: + - label: I have searched the existing issues and this is a new ticket, **NOT** a duplicate or related to another open or closed issue. + required: true + - label: I have written a short but informative title (ideally less than ~100 characters). + required: true + - label: I have tried the troubleshooting guide described in [README.md](https://github.com/Suwayomi/Suwayomi-Server?tab=readme-ov-file#troubleshooting-and-support) + required: true + - label: I have updated to the **[latest version](https://github.com/suwayomi/suwayomi-server/releases/latest)**. + required: true + - label: I have filled out all of the requested information in this form, including specific version numbers. + required: true + - label: I understand that **Suwayomi does not have or fix any extensions**, and I **will not receive help** for any issues related to sources or extensions. + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 60a28fa05..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -name: "🌟 Feature request" -title: "[Feature Request] " -about: "Suggest a feature to improve the project" -labels: "enhancement" ---- - -**PLEASE READ THIS** - -I acknowledge that: - -- I have updated to the latest version of the app. -- I have tried the troubleshooting guide described in `README.md` -- If this is a request for adding/changing an extension it should be brought up to your extension repo. -- If this is an issue with some extension not working properly, It does work in Tachiyomi application as intended. -- I have searched the existing issues and this is a new ticket **NOT** a duplicate or related to another open issue -- I will fill out the title and the information in this template - -Note that the issue will be automatically closed if you do not fill out the title or requested information. - -**DELETE THIS SECTION IF YOU HAVE READ AND ACKNOWLEDGED IT** - ---- - -## What feature should be added to Suwayomi? -Explain What the feature is and how it should work in detail. Remove this line after you are done. - -## Why/Project's Benefit/Existing Problem -Explain why this should be added. Remove this line after you are done. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..af4806791 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,37 @@ +name: 🌟 Feature request +description: Suggest a feature to improve Suwayomi-Server +labels: [enhancement] +body: + + - type: textarea + id: feature-description + attributes: + label: Describe your suggested feature + description: How can Suwayomi-Server be improved? + placeholder: | + Example: + "It should work like this..." + validations: + required: true + + - type: textarea + id: other-details + attributes: + label: Other details + placeholder: | + Additional details and attachments. + + - type: checkboxes + id: acknowledgements + attributes: + label: Acknowledgements + description: Read this carefully, we will close and ignore your issue if you skimmed through this. + options: + - label: I have searched the existing issues and this is a new ticket, **NOT** a duplicate or related to another open or closed issue. + required: true + - label: I have written a short but informative title (ideally less than ~100 characters). + required: true + - label: I have updated to the **[latest version](https://github.com/suwayomi/suwayomi-server/releases/latest)**. + required: true + - label: I have filled out all of the requested information in this form, including specific version numbers. + required: true \ No newline at end of file diff --git a/.github/workflows/issue_moderator.yml b/.github/workflows/issue_moderator.yml deleted file mode 100644 index 32e06ae8a..000000000 --- a/.github/workflows/issue_moderator.yml +++ /dev/null @@ -1,44 +0,0 @@ -name: Issue moderator - -on: - issues: - types: [opened, edited, reopened] - issue_comment: - types: [created] - -jobs: - autoclose: - runs-on: ubuntu-latest - steps: - - name: Moderate issues - uses: tachiyomiorg/issue-moderator-action@v2 - with: - repo-token: ${{ github.token }} - auto-close-rules: | - [ - { - "type": "title", - "regex": ".*.*", - "message": "You did not fill out the description in the title" - }, - { - "type": "title", - "regex": ".*(<|>)+.*", - "message": "You did not remove Angle brackets(< and >) from the title" - }, - { - "type": "body", - "regex": ".*DELETE THIS SECTION IF YOU HAVE READ AND ACKNOWLEDGED IT.*", - "message": "The acknowledgment section was not removed" - }, - { - "type": "body", - "regex": ".*(Suwayomi-Server version|Server Operating System|Server Desktop Environment|Server JVM version|Client Operating System|Client Web Browser):.*(\\(Example:|