Skip to main content
Version: v4.4.0

plugin.yaml

The plugin.yaml file contains information and settings for the Plugin used in your project or application.

plugin.yaml file attributes

To create a Plugin, use the command stk create plugin, you will get the basic structure of your Plugin. See an example below:

name: yaml-plugin
description: .yaml file sample of the Template's Plugin
display-name: yaml-plugin
picture: plugin.png
category: backend # Ref: https://docs.stackspot.com/latestcreators-guide/yaml-files/plugin/#category
compatibility:
- java
- spring
about: docs/about.md
usage: docs/usage.md
use-case: docs/use-case.md
implementation: docs/implementation.md
technologies: # Ref: https://docs.stackspot.com/latestcreators-guide/yaml-files/plugin/#technologies
- "Api"
types:
- app
inputs:
- label: Input Example
type: text
name: example
default: any text

Required Plugin's attributes

name

A string that defines the Plugin's name. This information defines the Plugin's identifier that is used in your application.

name: my-plugin

description

A string that describes the Plugin's purpose. It should contain relevant information to display to the users in the stk list plugin command.

description: Describe your Plugin explaining its purpose

types

A list of strings that define the Plugin's types. The available type is:

  • app Indicates that the Plugin can be applied to a Template: app-template.
types:
- app

Plugin's Optional Attributes

display-name

A string that defines the Plugin's name that will be displayed in the Studio's website, Template, or Stack:

display-name: Plugin name

picture A string that defines the image's name file. It will be displayed on the Studio's website. This file must be in the repository:

picture: "plugin.png"

category

A string that defines the Plugin or Stack category.

  • For Plugins: Any category can be entered.
  • For Stacks: It is mandatory to use one of the categories below:
    • Analytics
    • Backend
    • Frontend
    • Full Stack
    • SRE
category: Backend

compatibility

String list that defines compatible terms, technologies, or applications:

compatibility:
- String

about Path to a Markdown file present inside the repository that details the Stack or Plugin:

about: docs/about.md

usage Path to a markdown file in the repository, it details the Stack or Plugin usage:

usage: docs/usage.md

use-case

Path to a markdown file in the repository, it details a Stack use case:

use-case: docs/useCase.md

use-cases

Stack use-cases list:

use-cases: docs/useCases.md

use-cases.title

String with the use case title:

use-cases

use-cases.content

Path to a Markdown file in the repository, it details the use case:

docs/useCases.md

use-cases.stackfile Path to a Stackfile file in the repository related to a use case:

docs/stk.yaml

implementation

Path to a markdown file in the repository, it details the Stack implementation:

implementation: docs/implementation.md

Inputs

Check the Inputs from .yaml files section to see all the available input types.

technologies

String list of technologies related to a Stack or a Plugin. The technologies accepted in the technologies field must be defined exactly like the list below:

  • .NET
  • Allure
  • Angular
  • Apache Spark
  • Api
  • AWS DynamoDB
  • AWS ECS/Fargate
  • AWS EventBridge
  • AWS Glue
  • AWS Kafka
  • AWS Kinesis
  • AWS Lake Formation
  • AWS Lambda
  • AWS S3
  • AWS SNS
  • AWS SQS
  • Citric
  • CocoaPods
  • Cucumber
  • C#
  • Docker
  • Gradle
  • Jaeger
  • Java
  • JavaScript
  • Junit
  • Kakfa
  • Kotlin
  • Maven
  • Microfrontend
  • MySql
  • NextJS
  • Observability
  • OpenAPI
  • OpenTelemetry
  • Parquet
  • PostgreSql
  • Prometheus
  • Python
  • Queue
  • React
  • Redis
  • Rest
  • Rest Assured
  • Robot Framework
  • Secrets
  • Serenity BDD
  • Splunk
  • Springboot
  • Swift
  • Terraform
  • Typescript
  • Web
technologies: 
- ".NET"

Next steps

Check template.yaml references.

Was this page helpful?