Skip to content

Feat: Experimental support for Kinds via grafana-app-sdk #2842

Description

@stevesg

Which areas does this feature request relate to

  • Create Plugin
  • Sign Plugin
  • Plugin E2E
  • Plugin Meta Extractor
  • Documentation

Problem

Support is being added to Grafana for processing "app manifest" embedded in plugins, generated by grafana-app-sdk. It would be valuable to have support in create-plugin to setup the scaffolding to enhance the user experience.

Solution

Whilst this is considered experimental and not for general consumption, we can hide The extra scaffolding

create-plugin --feature-flags=experimentalAppSdk

and/or

create-plugin add experimental-app-sdk

The extra scaffolding would include:

  1. A directory for storing the .cue files, and some skeleton files:
    /kinds/...
  2. A command to run the app-sdk code generator
    npm run generate:kinds
  3. An extra copyFiles step in the build process to add the app-sdk-manifest.json to /dist
  4. An extra hint in AGENTS/instructions.md about app-sdk/kinds and how/when to run code generation

Alternatives

  • Variation on this is to add it to Go codegen/Magefile instead of npm (= e.g. mage generate-kinds), but frontend-only apps that define kinds are feasible and sensible.
  • Creating or adding the functionality an external tool is another option (e.g. the app-sdk itself)

Additional context

No response

Are you interested in contributing the solution?

  • Yes
  • No

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    Status
    🔬 In review

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions