From 3188508fd2461551fa767e60e1f77c606b091356 Mon Sep 17 00:00:00 2001 From: Robbert van der Helm Date: Sat, 28 Aug 2021 17:43:23 +0200 Subject: [PATCH] Replace the setup help template with a form --- .github/ISSUE_TEMPLATE/setup_help.md | 44 -------- .github/ISSUE_TEMPLATE/setup_help.yml | 149 ++++++++++++++++++++++++++ 2 files changed, 149 insertions(+), 44 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/setup_help.md create mode 100644 .github/ISSUE_TEMPLATE/setup_help.yml diff --git a/.github/ISSUE_TEMPLATE/setup_help.md b/.github/ISSUE_TEMPLATE/setup_help.md deleted file mode 100644 index 1e5380f4..00000000 --- a/.github/ISSUE_TEMPLATE/setup_help.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -name: Setup help -about: How do I install yabridge -title: "" -labels: "" -assignees: "" ---- - -Thanks for giving yabridge a shot! If you're having issues with plugins not working at all or scans timing out then make sure to check out the [troubleshooting common issues](https://github.com/robbert-vdh/yabridge#troubleshooting-common-issues) section of the readme. `yabridgectl sync` will also try to diagnose most if these issues for you during setup. - -Also try our [Discord](https://discord.com/invite/pyNeweqadf) for some quick help or questions. - -**Problem description** -A short description of the current situation. - -**System information** -- Plugin: [e.g. Vital, optional if this is a general issue] -- Plugin type: [VST2/VST3, optional if this is a general issue] -- Host: [e.g. Bitwig Studio, REAPER or Ardour] -- Operating system: [e.g. Manjaro, or Ubuntu 20.04] -- Wine version: [e.g. Wine Staging 5.13] -- Audio: [e.g. JACK2, ALSA, PipeWire] -- Installation method: [symlinks/copies], [manual/yabridgectl] -- yabridge version: [e.g. 1.3.0 or commit a29f43a] -- yabridgectl version: [e.g. 1.3.0 or commit a29f43a, if using] - -**Debug log** -Please also include a debug log if possible. If you are having issues with yabridgectl, then you can omit this section. - -1. First make sure that there are no leftover Wine processes left running in the - background using `wineserver -k`. -2. Launch your host from a terminal using: - - ```bash - rm -f /tmp/yabridge.log; env YABRIDGE_DEBUG_FILE=/tmp/yabridge.log YABRIDGE_DEBUG_LEVEL=2+editor - ``` - - Where `` is the name of your host, like `bitwig-studio`, `reaper`, or - `ardour6`. - -3. Try to scan or load the plugin that's causing issues. -4. `/tmp/yabridge.log` should now contain a debug log. You can either attach - this log directly to the issue by dragging the file onto this text box, or - you could upload the contents to a website like GitHub's Gists or Hastebin. diff --git a/.github/ISSUE_TEMPLATE/setup_help.yml b/.github/ISSUE_TEMPLATE/setup_help.yml new file mode 100644 index 00000000..af2480cf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/setup_help.yml @@ -0,0 +1,149 @@ +name: Setup help +description: How do I install yabridge +body: + - type: checkboxes + id: checks + attributes: + label: Thanks for giving yabridge a shot! + description: >- + If you're having issues with plugins not working at all or scans timing + out then make sure to check out the [troubleshooting common + issues](https://github.com/robbert-vdh/yabridge#troubleshooting-common-issues) + section of the readme. You should also read through the [known issues + and + fixes](https://github.com/robbert-vdh/yabridge#known-issues-and-fixes) + section. There may already be a solution or a workaround for the issue + you're having. + + + Also try our [Discord](https://discord.com/invite/pyNeweqadf) for some + quick help or questions. + options: + - label: >- + I read through both the troubleshooting and the known issues sections my + issue wasn't listed there + required: true + - type: textarea + id: description + attributes: + label: Problem description + placeholder: >- + A short description of the current situation. + - type: input + id: operating-system + attributes: + label: Operating system + placeholder: e.g. Manjaro, or Ubuntu 38.04 + validations: + required: true + - type: input + id: installation-source + attributes: + label: How did you install yabridge? + placeholder: e.g. directly from the releases page, or the yabridge-git AUR package + validations: + required: true + - type: input + id: yabridge-version + attributes: + label: yabridge version + placeholder: e.g. 3.5.2, or commit a29f43a + validations: + required: true + - type: input + id: yabridgectl-version + attributes: + label: yabridgectl version + placeholder: e.g. 3.5.2, or commit a29f43a + validations: + required: true + - type: dropdown + id: installation-method + attributes: + label: Plugin installation method + description: >- + From yabridge 2.1.0 onwards you should never have to use the old symlink + installation method anymore, and it will likely cause issues if you do + use it. + options: ["copies", "symlinks"] + validations: + required: true + - type: input + id: plugin + attributes: + label: Plugin + placeholder: e.g. Sausage Fattener + validations: + required: false + - type: dropdown + id: plugin-type + attributes: + label: Plugin type + options: ["VST2", "VST3", "both VST2 and VST3"] + validations: + required: false + - type: dropdown + id: plugin-arch + attributes: + label: Plugin architecture + options: ["64-bit", "32-bit", "both 64-bit and 32-bit"] + validations: + required: false + - type: input + id: host + attributes: + label: Host + placeholder: e.g. Bitwig Studio 4.0.1 + validations: + required: true + - type: input + id: desktop-environment + attributes: + label: Desktop environment or WM + description: This is only relevant if the issue is related to the plugin's editor. + placeholder: e.g. KDE Plasma 5.22.4 on Xorg + validations: + required: false + - type: input + id: gpu-model + attributes: + label: GPU model + description: This is only relevant if the issue is related to the plugin's editor. + placeholder: e.g. NVIDIA RTX 3090 Ti SUPER + validations: + required: false + - type: input + id: gpu-drivers + attributes: + label: GPU drivers and kernel + description: This is only relevant if the issue is related to the plugin's editor. + placeholder: e.g. Mesa 21.1.6 on Linux 5.14.0 + validations: + required: false + - type: textarea + id: debug-log + attributes: + label: Debug log + description: | + Please also include a debug log if possible. If you are reporting an issue with yabridgectl, then you can omit this section. + + 1. First make sure that there are no leftover Wine processes left running in the background using `wineserver -k`. + 2. Launch your host from a terminal using: + + ```bash + rm -f /tmp/yabridge.log; env YABRIDGE_DEBUG_FILE=/tmp/yabridge.log YABRIDGE_DEBUG_LEVEL=2+editor + ``` + + Where `` is the name of your host, like `bitwig-studio`, `reaper`, or `ardour6`. + + 3. Try to scan or load the plugin that's causing issues. + 4. `/tmp/yabridge.log` should now contain a debug log. You can drag this file directly onto the text field below to upload it to GitHub. + validations: + required: false + - type: textarea + id: other-information + attributes: + label: Anything else? + placeholder: If there's anything else you'd like to add, then you can do so here. + validations: + required: false