bug_report.yaml

name: Report an issue with Immich
description: Report an issue with Immich
labels: ["bug", "need triage"]
title: "[BUG] <title>"
body:
  - type: markdown
    attributes:
      value: |
        This issue form is for reporting bugs only!

        If you have a feature or enhancement request, please use the [feature request][fr] section of our [GitHub Discussions][fr].

        [fr]: https://github.com/immich-app/immich/discussions/new?category=feature-request

  - type: textarea
    validations:
      required: true
    attributes:
      label: The bug
      description: >-
        Describe the issue you are experiencing here, to communicate to the
        maintainers. Tell us what you were trying to do and what happened.

        Provide a clear and concise description of what the problem is.

  - type: markdown
    attributes:
      value: |
        ## Environment

  - type: input
    validations:
      required: true
    attributes:
      label: The OS that Immich Server is running on
      placeholder: Ubuntu 22.10, Debian, Arch...etc

  - type: input
    id: version
    validations:
      required: true
    attributes:
      label: Version of Immich Server
      placeholder: v1.0.0

  - type: input
    validations:
      required: true
    attributes:
      label: Version of Immich Mobile App
      placeholder: v1.0.0

  - type: checkboxes
    validations:
      required: true
    attributes:
      label: Platform with the issue
      options:
        - label: Server
        - label: Web
        - label: Mobile

  - type: textarea
    validations:
      required: true
    attributes:
      label: Your docker-compose.yml content
      render: YAML

  - type: textarea
    validations:
      required: true
    attributes:
      label: Your .env content
      description: Please provide the redacted .env content of your setup
      render: Shell

  - type: textarea
    id: repro
    attributes:
      label: Reproduction steps
      description: "How do you trigger this bug? Please walk us through it step by step."
      value: |
        1.
        2.
        3.
        ...
      render: bash
    validations:
      required: true

  - type: textarea
    attributes:
      label: Additional information
      description: >
        If you have any additional information for us, use the field below.

  - type: markdown
    attributes:
      value: Thank you for submitting the form