Skip to content

feat: add optional Kagenti version field to bug report template #74

Description

@rubambiza

Summary

Add an optional field to the bug report template (3-bug-report.yml) where users can indicate which version of Kagenti they were running when they encountered the bug.

Motivation

Knowing the version helps maintainers:

  • Quickly determine if the bug has already been fixed in a newer release
  • Identify regressions introduced between specific versions
  • Determine whether a fix needs to be applied to a supported release branch

Proposed change

Add an input field between "Expected Behavior" and "Additional Context":

  - type: input
    id: version
    attributes:
      label: Kagenti Version
      description: |
        Which version of Kagenti were you running? Check with:
        helm list -n kagenti-system (app version column), or the git tag you checked out.
      placeholder: "v0.6.0"
    validations:
      required: false

Why optional

There is currently no single CLI command or API endpoint that surfaces the platform version. The closest options are:

  • helm list -n kagenti-system (requires cluster access)
  • The git tag used at install time

Until there's a /version endpoint or equivalent, making this required would frustrate reporters who don't have easy access to this info.

Follow-up consideration

Consider adding a GET /api/v1/version endpoint (or enriching /health) to return the platform version. That would make it feasible to mark this field as required in the future.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

Status
Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions