Add GitHub bug report issue template (#813)

* Add GitHub bug report issue template - Bug report form with install method dropdown (npm, Docker, source, other) and version dropdown listing all pre-release versions (alpha.2–alpha.6) - Includes optional agent-server version, environment, logs/screenshots fields Co-authored-by: openhands <openhands@all-hands.dev> * Remove agent server version field from bug report template Co-authored-by: openhands <openhands@all-hands.dev> * Remove environment field from bug report template Co-authored-by: openhands <openhands@all-hands.dev> * Add OS dropdown to bug report template Co-authored-by: openhands <openhands@all-hands.dev> * Address review feedback on bug report template - Convert version dropdown to free-text input to avoid maintenance burden - Fix docker inspect description to include image reference - Add Actual Behavior field between Steps to Reproduce and Expected Behavior - Split Logs/Screenshots into separate fields so render:shell doesn't break images Co-authored-by: openhands <openhands@all-hands.dev> * Add --version flag to CLI and version label to Docker image - bin/agent-canvas.mjs: add -v/--version flag that reads version from package.json - docker/Dockerfile: add AGENT_CANVAS_VERSION build arg and org.opencontainers.image.version label - .github/workflows/docker.yml: extract version from package.json, pass as build arg - bug_report.yml: update version field description with the actual commands users can run Co-authored-by: openhands <openhands@all-hands.dev> * Update version description: use image tag for Docker (label not yet released) Co-authored-by: openhands <openhands@all-hands.dev> --------- Co-authored-by: openhands <openhands@all-hands.dev>
2026-10-06 12:33:43 +08:00 · 2026-05-27 12:17:35 -04:00
parent 4655f7a119
commit f2d19c8923
4 changed files with 119 additions and 2 deletions
@@ -0,0 +1,105 @@
+name: Bug Report
+description: Report a bug or unexpected behavior in Agent Canvas.
+title: "[Bug]: "
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to report a bug! Please fill out the sections below so we can reproduce and fix the issue.
+
+  - type: dropdown
+    id: os
+    attributes:
+      label: Operating System
+      options:
+        - macOS
+        - Windows
+        - Linux
+    validations:
+      required: true
+
+  - type: dropdown
+    id: install-method
+    attributes:
+      label: Installation Method
+      description: How did you install / run Agent Canvas?
+      options:
+        - npm (`npx @openhands/agent-canvas` or `npm install -g @openhands/agent-canvas`)
+        - Docker (`ghcr.io/openhands/agent-canvas`)
+        - From source (`npm run dev` / `npm run dev:minimal`)
+        - Other
+    validations:
+      required: true
+
+  - type: input
+    id: version
+    attributes:
+      label: Agent Canvas Version
+      description: "npm: `agent-canvas --version` · Docker: the image tag you pulled (e.g. `ghcr.io/openhands/agent-canvas:latest`)"
+      placeholder: "e.g. 1.0.0-alpha.6"
+    validations:
+      required: true
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Bug Description
+      description: A clear and concise description of what the bug is.
+      placeholder: What happened?
+    validations:
+      required: true
+
+  - type: textarea
+    id: steps
+    attributes:
+      label: Steps to Reproduce
+      description: Step-by-step instructions to reproduce the behavior.
+      placeholder: |
+        1. Go to '...'
+        2. Click on '...'
+        3. Scroll down to '...'
+        4. See error
+    validations:
+      required: true
+
+  - type: textarea
+    id: actual
+    attributes:
+      label: Actual Behavior
+      description: What actually happened?
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected Behavior
+      description: What did you expect to happen?
+    validations:
+      required: true
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant Logs
+      description: Paste any error messages or console output. Content is auto-wrapped in a code block.
+      render: shell
+    validations:
+      required: false
+
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Screenshots
+      description: Drag and drop or paste any screenshots that help explain the issue.
+    validations:
+      required: false
+
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional Context
+      description: Anything else that might be helpful (config, workarounds tried, etc.).
+    validations:
+      required: false
@@ -90,9 +90,11 @@ jobs:
          AGENT_SERVER_VERSION=$(node -p "require('./config/defaults.json').versions.agentServer")
          AGENT_SERVER_IMAGE_BASE=$(node -p "require('./config/defaults.json').images.agentServer")
          AUTOMATION_VERSION=$(node -p "require('./config/defaults.json').versions.automation")
+          AGENT_CANVAS_VERSION=$(node -p "require('./package.json').version")
          echo "agent_server_version=$AGENT_SERVER_VERSION" >> "$GITHUB_OUTPUT"
          echo "default_agent_server_image=${AGENT_SERVER_IMAGE_BASE}:${AGENT_SERVER_VERSION}-python" >> "$GITHUB_OUTPUT"
          echo "default_automation_version=$AUTOMATION_VERSION" >> "$GITHUB_OUTPUT"
+          echo "agent_canvas_version=$AGENT_CANVAS_VERSION" >> "$GITHUB_OUTPUT"

      - name: Compute metadata and tags
        id: prep
@@ -184,6 +186,7 @@ jobs:
          build-args: |
            AGENT_SERVER_IMAGE=${{ steps.prep.outputs.agent_server_image }}
            AUTOMATION_VERSION=${{ steps.prep.outputs.automation_version }}
+            AGENT_CANVAS_VERSION=${{ steps.config.outputs.agent_canvas_version }}
            OPENHANDS_BUILD_GIT_SHA=${{ env.RELEVANT_SHA }}
            OPENHANDS_BUILD_GIT_REF=${{ env.RELEVANT_REF }}
            VITE_APP_ENV=${{ steps.prep.outputs.vite_app_env }}
@@ -11,16 +11,22 @@
 * but serves pre-built static assets instead of the Vite dev server.
 */

-import { existsSync } from "node:fs";
+import { existsSync, readFileSync } from "node:fs";
 import { join, dirname } from "node:path";
 import { fileURLToPath } from "node:url";

 const __dirname = dirname(fileURLToPath(import.meta.url));
+const PKG_JSON = join(__dirname, "..", "package.json");
 // Build output is in build/ (not build/client/) - see react-router.config.ts unpackClientDirectory
 const BUILD_DIR = join(__dirname, "..", "build");

-// Check for help flag first
+// Check for version/help flags first
 const args = process.argv.slice(2);
+if (args.includes("-v") || args.includes("--version")) {
+  const { version } = JSON.parse(readFileSync(PKG_JSON, "utf-8"));
+  console.log(version);
+  process.exit(0);
+}
 if (args.includes("-h") || args.includes("--help")) {
  console.log(`
@openhands/agent-canvas - Run the Agent Canvas UI with agent-server
@@ -33,6 +39,7 @@ USAGE:

 OPTIONS:
  -p, --port <port>     Ingress port (default: 8000)
+  -v, --version         Show version number
  -h, --help            Show this help message

 ENVIRONMENT VARIABLES:
@@ -68,9 +68,11 @@ ARG AUTOMATION_VERSION
 ARG OPENHANDS_BUILD_GIT_SHA=unknown
 ARG OPENHANDS_BUILD_GIT_REF=unknown

+ARG AGENT_CANVAS_VERSION=dev
 LABEL org.opencontainers.image.title="agent-canvas"
 LABEL org.opencontainers.image.description="All-in-one agent-canvas: Agent Server + Automation + Frontend"
 LABEL org.opencontainers.image.source="https://github.com/OpenHands/agent-canvas"
+LABEL org.opencontainers.image.version="${AGENT_CANVAS_VERSION}"
 LABEL org.opencontainers.image.revision="${OPENHANDS_BUILD_GIT_SHA}"

 ENV AGENT_CANVAS_BUILD_GIT_SHA=${OPENHANDS_BUILD_GIT_SHA}