mirror of
https://github.com/bytedance/deer-flow.git
synced 2026-07-28 08:56:13 +00:00
cf02646489
* feat(scripts): add redacted community support bundle generator Add `make support-bundle` (scripts/support_bundle.py) to help users file high-signal, privacy-safe GitHub issues for local setup/config/runtime problems. The command produces: - `*-issue-summary.md` to paste into the issue body - `*-issue-draft.md` scaffold for AI-assisted filing (REQUIRED placeholders, never invents repro/expected/summary facts) - an optional evidence zip under `.deer-flow/support-bundles/` containing a stable `triage.json` plus redacted environment/config/extensions/git/doctor evidence Privacy: secrets are redacted across config values, URL userinfo, query strings, CLI flags, custom headers, bearer/sk- tokens, and home paths. The bundle never includes `.env`, raw conversation messages, or user file contents; optional `--thread-id` adds file manifests only. `thread_id` input is validated against path traversal. Wire it into the Makefile, AGENTS.md, README/README_zh, CONTRIBUTING, and the bug-report issue template. Covered by backend/tests/test_support_bundle.py. * fix(scripts): redact MCP env values by default in support bundle Address PR #3886 review (willem-bd, P2): the key-name allowlist let literal secrets under non-standard env keys (e.g. SUPABASE_SERVICE_ROLE_KEY, R2_ACCESS_KEY, hardcoded AIza… keys) leak verbatim into the bundle that users are told is safe to share publicly. Mask all MCP `env` values by default, keeping only `$VAR`/`${VAR}` references visible, and broaden SECRET_KEY_RE (access_key, pwd, private_key). Add tests for non-keyword env secrets, broadened key names, and end-to-end zip redaction.
171 lines
4.6 KiB
YAML
171 lines
4.6 KiB
YAML
name: 🐛 Bug report
|
|
description: Report something that isn't working so maintainers can reproduce and fix it.
|
|
title: "[bug] "
|
|
labels: ["bug"]
|
|
body:
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
Thanks for taking the time to file a bug. A clear, reproducible report is the
|
|
single biggest factor in how fast it gets fixed.
|
|
|
|
Please fill in every required field — especially **reproduction steps** and **logs**.
|
|
|
|
- type: checkboxes
|
|
id: preflight
|
|
attributes:
|
|
label: Before you start
|
|
options:
|
|
- label: I searched [existing issues](https://github.com/bytedance/deer-flow/issues?q=is%3Aissue) and this is not a duplicate.
|
|
required: true
|
|
- label: I can reproduce this on the latest `main`.
|
|
required: false
|
|
|
|
- type: input
|
|
id: summary
|
|
attributes:
|
|
label: Problem summary
|
|
description: One sentence describing the bug.
|
|
placeholder: e.g. make dev fails to start the gateway service
|
|
validations:
|
|
required: true
|
|
|
|
- type: dropdown
|
|
id: areas
|
|
attributes:
|
|
label: Affected area(s)
|
|
description: Which part of DeerFlow does this touch? Select all that apply.
|
|
multiple: true
|
|
options:
|
|
- Frontend (UI / Next.js)
|
|
- Backend API (gateway / endpoints / SSE)
|
|
- Agents / LangGraph (graph, prompts, langgraph.json)
|
|
- Sandbox / Docker
|
|
- Skills
|
|
- MCP
|
|
- Config / setup (make, config.yaml, env)
|
|
- Docs
|
|
- CI infra
|
|
- Not sure
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: actual
|
|
attributes:
|
|
label: What happened?
|
|
description: The actual behavior. Include the key error lines verbatim.
|
|
placeholder: When I do X, I expected Y but I got Z.
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: expected
|
|
attributes:
|
|
label: Expected behavior
|
|
placeholder: What did you expect to happen instead?
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: reproduce
|
|
attributes:
|
|
label: Steps to reproduce
|
|
description: Exact commands and sequence. Minimal steps that reliably reproduce the problem.
|
|
placeholder: |
|
|
1. make check
|
|
2. make install
|
|
3. make dev
|
|
4. ...
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: logs
|
|
attributes:
|
|
label: Relevant logs
|
|
description: Paste key lines from logs (for example `logs/gateway.log`, `logs/frontend.log`). Redact secrets.
|
|
render: shell
|
|
validations:
|
|
required: true
|
|
|
|
- type: dropdown
|
|
id: run_mode
|
|
attributes:
|
|
label: How are you running DeerFlow?
|
|
options:
|
|
- Local (make dev)
|
|
- Docker (make docker-start)
|
|
- CI
|
|
- Other
|
|
validations:
|
|
required: true
|
|
|
|
- type: dropdown
|
|
id: os
|
|
attributes:
|
|
label: Operating system
|
|
options:
|
|
- macOS
|
|
- Linux
|
|
- Windows
|
|
- Other
|
|
validations:
|
|
required: true
|
|
|
|
- type: input
|
|
id: platform_details
|
|
attributes:
|
|
label: Platform details
|
|
description: Architecture and shell, if relevant.
|
|
placeholder: e.g. arm64, zsh
|
|
|
|
- type: input
|
|
id: python_version
|
|
attributes:
|
|
label: Python version
|
|
placeholder: e.g. Python 3.12.9
|
|
|
|
- type: input
|
|
id: node_version
|
|
attributes:
|
|
label: Node.js version
|
|
placeholder: e.g. v22.11.0
|
|
|
|
- type: input
|
|
id: pnpm_version
|
|
attributes:
|
|
label: pnpm version
|
|
placeholder: e.g. 10.26.2
|
|
|
|
- type: input
|
|
id: uv_version
|
|
attributes:
|
|
label: uv version
|
|
placeholder: e.g. 0.7.20
|
|
|
|
- type: textarea
|
|
id: git_info
|
|
attributes:
|
|
label: Git state
|
|
description: Output of `git branch --show-current` and the latest commit SHA.
|
|
placeholder: |
|
|
branch: feature/my-branch
|
|
commit: abcdef1
|
|
|
|
- type: textarea
|
|
id: support_bundle
|
|
attributes:
|
|
label: Support bundle summary
|
|
description: For local setup, configuration, sandbox, or runtime issues, run `make support-bundle` and paste the generated `*-issue-summary.md` here. AI-assisted reports can start from `*-issue-draft.md`, but every REQUIRED placeholder must be replaced before filing. Attach the zip only if a maintainer asks for the evidence bundle or the summary is not enough.
|
|
placeholder: |
|
|
## DeerFlow support bundle summary
|
|
- Triage status: ...
|
|
- Active signals: ...
|
|
|
|
- type: textarea
|
|
id: additional
|
|
attributes:
|
|
label: Additional context
|
|
description: Screenshots, related issues, config snippets (redacted), or anything else that helps triage.
|