add a crash template, and remove redundancies (#3255)

juliuspfadt · web-flow · commit af6283a4a2da · 2025-02-27T18:49:26.000+08:00
* add a crash template, and remove redundancies

* use placeholder instead of value for required fields in bug and crash tempalte
diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -99,7 +99,7 @@ body:
     attributes:
       label: What analysis are you seeing the problem on?
       description: Please mention the name of the analysis or method that the causes the issue.
-      placeholder: "One Sample T-Test"
+      placeholder: One Sample T-Test
     validations:
       required: false
   - type: dropdown
@@ -133,7 +133,7 @@ body:
         Please tell us what happened.
         
         Note: You can attach images or log files by clicking this area to highlight it and then dragging files in. If you upload a JASP file, you need to compress your .jasp-file before uploading it to GitHub (aka as a .zip-file; for additional help, see https://jasp-stats.org/2018/03/29/request-feature-report-bug-jasp/). In addition, if you would prefer to not make your data publicly available, you can send your files directly to us, issues@jasp-stats.org.
-      placeholder: "A bug happened!"
+      placeholder: A bug happened!
     validations:
       required: true
   - type: textarea
@@ -149,7 +149,7 @@ body:
     attributes:
       label: Steps to Reproduce
       description: Can you reproduce the bug? If so, please let us know what steps you take to reproduce this bug.
-      value: |
+      placeholder: |
         1.
         2.
         3.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,5 +1,5 @@
 blank_issues_enabled: false
 contact_links:
-  - name: JASP Guide for Requesting Features or Reporting Bugs
+  - name: JASP Guide for Requesting Features or Reporting Bugs/Crashes
     url: https://jasp-stats.org/2018/03/29/request-feature-report-bug-jasp/
-    about: Please use one of the templates to request a feature or report a bug
+    about: Please use one of the templates to request a feature, report a bug or a crash
diff --git a/.github/ISSUE_TEMPLATE/crash-report.yml b/.github/ISSUE_TEMPLATE/crash-report.yml
@@ -0,0 +1,99 @@
+name: Crash Report
+description: File a crash report
+labels: Crash
+title: "[Crash]: "
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this crash report! If this is your first time reporting an issue, please read our [guide](https://jasp-stats.org/2018/03/29/request-feature-report-bug-jasp/) first.
+  - type: textarea
+    id: system-info
+    attributes:
+      label: System Info
+      description: Please fill the system information into this field. If you have arrived here via the crash reporter in JASP, this will be filled automatically. If not, go to JASP > About > Copy Debug Information.
+      placeholder: JASP Version: 0.19.3 (Apple Silicon) | Build Branch: 0.19.3 | Build Date: Jan 3 2025 12:51:39 (Netherlands) | Last Commit: c8710df5442149527b0692cc1367ea5b3c982d04 | OS: macOS Sequoia 15.3 (darwin 24.3.0, arm64) | Install Path: /Applications/JASP.app/Contents/MacOS | Platform: cocoa | System Locale: en_NL
+    validations:
+      required: true
+  - type: dropdown
+    id: jasp-module
+    attributes:
+      label: JASP Module
+      description:  Is there a specific JASP module that caused the crash?
+      multiple: true
+      options:
+        - Unrelated
+        - Acceptance Sampling
+        - ANOVA
+        - Audit
+        - Bain
+        - Bayes Factor Functions
+        - BFpack
+        - Bsts
+        - Circular Statistics
+        - Cochrane Meta-Analyses
+        - Descriptives
+        - Distributions
+        - Equivalence T-Tests
+        - Factor
+        - Frequencies
+        - JAGS
+        - Learn Bayes
+        - Learn Stats
+        - Machine Learning
+        - Meta Analysis
+        - Mixed Models
+        - Network
+        - Power
+        - Predictive Analytics
+        - Process
+        - Prophet
+        - Quality Control
+        - Regression
+        - Reliability
+        - Robust T-Tests
+        - SEM
+        - Survival
+        - Summary Statistics
+        - T-Tests
+        - Time Series
+        - Visual Modeling
+        - Other
+    validations:
+      required: true
+  - type: input
+    id: jasp-analysis
+    attributes:
+      label: Is there a specific analysis that caused the crash?
+      description: Please mention the name of the analysis or method that the causes the issue.
+      placeholder: One Sample T-Test
+    validations:
+      required: false
+  - type: textarea
+    id: log
+    attributes:
+      label: Log files
+      description:
+        Please upload your Log files by dropping them into the area below, and add any information notes if necessary.
+        
+        **Read our [Logging Guide](https://github.com/jasp-stats/jasp-desktop/blob/stable/Docs/user-guide/logging-howto.md) page to learn where to (and how to) find JASP log files.**
+    validations: 
+      required: true
+  - type: textarea
+    id: steps-to-reproduce
+    attributes:
+      label: Steps to Reproduce
+      description: |
+        Please tell us what happened. Can you reproduce the crash? If so, please let us know what steps you take to reproduce this bug.
+        
+        Note: You can attach images or data by clicking this area to highlight it and then dragging files in. If you upload a JASP file, you need to compress your .jasp-file before uploading it to GitHub (aka as a .zip-file; for additional help, see https://jasp-stats.org/2018/03/29/request-feature-report-bug-jasp/). In addition, if you would prefer to not make your data publicly available, you can send your files directly to us, issues@jasp-stats.org.
+      placeholder: |
+        1.
+        2.
+        3.
+        ...
+        
+    validations:
+      required: true
+
+
diff --git a/.github/scripts/crash_firstResponse.js b/.github/scripts/crash_firstResponse.js
@@ -0,0 +1,35 @@
+module.exports = async function ({github, context}) {
+  const issue = await github.rest.issues.get({
+    issue_number: context.issue.number,
+    owner: context.repo.owner,
+    repo: context.repo.repo
+  });
+  
+  const body = issue.data.body;
+  // if any of these string are in the issue body, then there was a user upload, 
+  // the first string covers all the image/video files
+  const regex = /\.log\b/; // Updated regex to remove "user-attachments"
+  if (!regex.test(body)) {
+    const comment = "@" + issue.data.user.login +
+      ", thanks for taking the time to create this report. \
+      Please upload to the issue website (" 
+      + issue.data.html_url +
+      ", attaching to an email does not work) the **log files** from JASP. \
+      For more information read our [Logging Guide](https://github.com/jasp-stats/jasp-desktop/blob/stable/Docs/user-guide/logging-howto.md) \
+      page to learn where to (and how to) find JASP log files.";
+
+    github.rest.issues.createComment({
+      issue_number: context.issue.number,
+      owner: context.repo.owner,
+      repo: context.repo.repo,
+      body: comment
+    });
+
+    github.rest.issues.addLabels({
+      issue_number: context.issue.number,
+      owner: context.repo.owner,
+      repo: context.repo.repo,
+      labels: ["Waiting for requester"]
+    });
+  };
+}
diff --git a/.github/scripts/feature_labelAssign.js b/.github/scripts/feature_labelAssign.js
diff --git a/.github/scripts/issue_labelAssign.js b/.github/scripts/issue_labelAssign.js
@@ -4,8 +4,6 @@ module.exports = async function ({github, context}, keywords) {
   // define an array of keyword triples, including the label and 
   // the maintainer to assign
 
-
-
   // get the issue info
   const issue = await github.rest.issues.get({
                         issue_number: context.issue.number,
@@ -27,8 +25,8 @@ module.exports = async function ({github, context}, keywords) {
   }
 
   // test if module keyword is in issue body
-  const regexModule1 = "\\#\\#\\# JASP Module\\s+,*.*("
-  const regexModule2 = ").*\\s+\\#\\#\\#";
+  const regexModule1 = "### (JASP Module|Is your feature request related to a JASP module\\?)\\s+,*.*(";
+  const regexModule2 = ").*\\s+###";
   for (const words of keywords.modules) {
     // create the regex to match with, case insensitive
     var regex = new RegExp(regexModule1 + words[0] + regexModule2, "i");
diff --git a/.github/workflows/issue_firstResponse copy.yml b/.github/workflows/issue_firstResponse copy.yml
@@ -8,7 +8,7 @@ on:
       - opened
 
 jobs:
-  First-response:
+  First-response-bug:
     runs-on: ubuntu-latest
     if: ${{ contains(github.event.issue.labels.*.name, 'Bug') }}
     steps:
@@ -18,4 +18,14 @@ jobs:
           script: |
             const script = require('./.github/scripts/bug_firstResponse.js');
             script({github, context});
-
+  
+  First-response-crash:
+    runs-on: ubuntu-latest
+    if: ${{ contains(github.event.issue.labels.*.name, 'Crash') }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/github-script@v6
+        with:
+          script: |
+            const script = require('./.github/scripts/crash_firstResponse.js');
+            script({github, context});
diff --git a/.github/workflows/issue_labelAndAssign.yml b/.github/workflows/issue_labelAndAssign.yml
@@ -1,51 +1,19 @@
-
-# The script consists of several steps:
-# 1. define module keyword patterns, the designated label and assignee
-# 2. define operating system keyword patterns, and the designated label
-# 3. get the info about the issue
-# 4. check if module keyword pattern matches text in the issue, 
-#   looping over all patterns:
-#   - if pattern is found, label the issue, and assign the maintainer
-#   - if the pattern is not found, check if the label or assignee for the pattern
-#     is attached to the issue and remove them
-# 5. do 4 but with OS keyword patterns
-
-# so far this workflow works best with the bug_template. 
-# some resources: https://github.com/actions/github-script
-#                 https://octokit.github.io/rest.js/v19
-#                 https://docs.github.com/en/rest
-
-
 name: Label and Assign
 on:
   issues:
-    types: 
+    types:
       - opened
       - reopened
 
 jobs:
-  Bug-label-and-assign:
+  Label-and-assign:
     runs-on: ubuntu-latest
-    if: ${{ contains(github.event.issue.labels.*.name, 'Bug') }}
     steps:
       - uses: actions/checkout@v3
       - uses: actions/github-script@v6
         with:
           script: |
             const keyFun = require('./.github/scripts/keywords.js');
             const keywords = keyFun();
-            const script = require('./.github/scripts/bug_labelAssign.js');
-            script({github, context}, keywords);
-
-  Feature-label-and-assign:
-      runs-on: ubuntu-latest
-      if: ${{ contains(github.event.issue.labels.*.name, 'Feature Request') }}
-      steps:
-        - uses: actions/checkout@v3
-        - uses: actions/github-script@v6
-          with:
-            script: |
-              const keyFun = require('./.github/scripts/keywords.js');
-              const keywords = keyFun();
-              const script = require('./.github/scripts/feature_labelAssign.js');
-              script({github, context}, keywords);
+            const script = require('./.github/scripts/issue_labelAssign.js');
+            script({github, context}, keywords);
