mirror of
https://github.com/orangecoding/fredy.git
synced 2026-06-16 12:31:07 +00:00
113 lines
4.0 KiB
YAML
113 lines
4.0 KiB
YAML
name: Bug Report
|
|
description: Help us improve Fredy by reporting a bug
|
|
title: "[Bug]: "
|
|
labels: [bug]
|
|
assignees: []
|
|
|
|
body:
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
## Please attach a debug bundle (available since Fredy 22.5.0+)
|
|
|
|
Since **Fredy 22.5.0** you can export a debug bundle that contains a system
|
|
snapshot (`sys.txt`, Fredy version, Node.js version, OS, Docker detection,
|
|
CPU, memory, sanitized settings) and the full log buffer (`logs.txt`) that
|
|
Fredy recorded while you reproduced the issue. Attaching it dramatically
|
|
speeds up triage.
|
|
Oh and before you ask: I decided against simply putting all logs into the debug
|
|
due to privacy reasons :)
|
|
|
|
**The bundle is only useful when the error is actually inside `logs.txt`.**
|
|
That means you have to record first, reproduce after:
|
|
|
|
1. Log in to Fredy as **admin** and open **Settings → Debug**.
|
|
2. Click **"Enable debug logging" / "Debug-Logging aktivieren"**. A red banner
|
|
appears across the whole app while recording is on.
|
|
3. **Now reproduce the bug.** Trigger the broken job, click the failing
|
|
button, wait for the failing scrape — whatever it was.
|
|
4. Come back to **Settings → Debug** and confirm the progress bar moved
|
|
(i.e. log entries were actually written). If it stayed at 0%, nothing was
|
|
captured and the bundle won't help us.
|
|
5. Click **"Download debug information" / "Debug Informationen herunterladen"**
|
|
and drop the resulting `FredyDebug-*.zip` into the "Screenshots / Logs"
|
|
field below.
|
|
6. Optional but recommended: click **"Disable debug logging"** to stop the
|
|
recording, and **"Delete stored debug logs"** once you have the zip so the
|
|
database does not keep them around.
|
|
|
|
On Fredy versions older than 22.5.0, paste the relevant log lines from your
|
|
console / Docker / systemd journal manually instead.
|
|
|
|
- type: textarea
|
|
id: description
|
|
attributes:
|
|
label: Bug Description
|
|
description: Provide a clear and concise description of the bug.
|
|
placeholder: e.g. "Fredy crashes when I click on Save."
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: steps
|
|
attributes:
|
|
label: Steps to Reproduce
|
|
description: List the steps to reproduce the issue.
|
|
placeholder: |
|
|
1. Go to '...'
|
|
2. Click on '...'
|
|
3. Scroll down to '...'
|
|
4. See error
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: expected
|
|
attributes:
|
|
label: Expected Behavior
|
|
description: What did you expect to happen?
|
|
placeholder: "It should save without errors."
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: actual
|
|
attributes:
|
|
label: Actual Behavior
|
|
description: What actually happened?
|
|
placeholder: "Fredy crashed with error XYZ."
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: screenshots
|
|
attributes:
|
|
label: Screenshots / Logs
|
|
description: |
|
|
Drop the FredyDebug-*.zip here (see the instructions at the top, available
|
|
since Fredy 22.5.0) and/or any additional screenshots. If you cannot produce
|
|
the bundle, paste relevant log lines instead.
|
|
placeholder: "Drag and drop the FredyDebug-*.zip and any screenshots here."
|
|
validations:
|
|
required: false
|
|
|
|
- type: input
|
|
id: environment
|
|
attributes:
|
|
label: Environment
|
|
description: |
|
|
Provide details about your environment. You can copy most of this from
|
|
sys.txt inside the debug bundle.
|
|
placeholder: "OS: macOS 15, Browser: Chrome 124, App version: 22.5.0, Docker: yes"
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: context
|
|
attributes:
|
|
label: Additional Context
|
|
description: Add any other context about the problem here.
|
|
placeholder: "Any other information that might help..."
|
|
validations:
|
|
required: false
|