stack.yaml

Example of a `stack.yaml` file

schema-version: v1 #required
kind: stack #required
metadata: #required
  name: Stack sample #required
  display-name: stack-sample #required
  description: Stack description. #required
  version: 1.0.0 #required
  tags: #optional
    - example-tag-one
    - example-tag-two
    - example-tag-three
spec: #required
  docs: #required
    en-us: docs/en_us/docs.md #required at least one language
    pt-br: docs/pt_br/docs.md
  links: #optional
    - name: Example Repository
      url: https://github.com/example/myorganization
      picture: https://image-png.com
    - name: Example Repository02
      url: https://github.com/example/myorganization
      picture: https://image-png.com
  plugins: #required at least one Application or Infrastructure Plugin
    app:
      - name: example-studio/app-plugin-basic@0.0.1
      - name: example-studio/run-action-hook-plugin@0.0.2
    infra:
      - name: example-studio/infra-generates-sns@0.0.1
        actions:
          - name: example-studio/requires-sns-action@0.0.1
      - name: example-studio/infra-plugin-basic@0.0.1
      - name: example-studio/plugin-infra2108@0.0.3
  actions: #optional
    - name: example-studio/action-basic@0.0.1
    - name: example-studio/action-with-connection@0.0.1
    - name: example-studio/requires-sns-action@0.0.1
  starters: #required
    - path: starters/basic-starter

Stack Attributes

`schema-version`

Manifest schema version.

schema-version: v1

`kind`

Manifest type.

kind: stack

`metadata`

Metadata that identifies the Stack. It contains the following attributes:

name

Technical identifier (slug) of the Stack. It must be unique within the Studio and use kebab-case.

name: stack-name-example

display-name

Friendly name that will be displayed in the Portal for the Stack.

display-name: stack-display-name-example

description

Stack description. It must have at least three characters and at most 500 characters.

description: Stack example

version

Stack version. Follows Semantic Versioning (SemVer).

version: 1.0.0

`spec`

Stack technical specification.

docs

Markdown files with the Stack documentation. At least one language must be defined.

docs:
  pt-br: docs/pt-br/docs.md
  en-us: docs/en-us/docs.md

links

List of static and dynamic links related to the Stack. Links are visible in Stacks published on StackSpot.
The links are similar to those added in Plugins. For more details, see how to add links in Plugins.

spec:
  docs:
    en-us: docs/en_us/docs.md
    pt-br: docs/pt_br/docs.md
  links:
    - name: Example Repository
      url: https://github.com/example/myorganization
      picture: https://image-png.com
    - name: Example Repository02
      url: https://github.com/example/myorganization
      picture: https://image-png.com

plugins

List of Plugins present in your Stack. They are organized by types app (Application) and infra (Infrastructure).
They must be added with the syntax: - name: studio-slug/plugin-name@[semantic-version].

To associate Actions in infra Plugins, use the syntax: - name: studio-slug/action-name@[semantic-version].
To learn more, see how to associate Actions in Infra Plugins.

warning

Plugins are required properties in Stacks. At least one Plugin of type app or infra must be added.

spec:
  docs:
    en-us: docs/en_us/docs.md
    pt-br: docs/pt_br/docs.md
  plugins: #required at least one Application or Infrastructure Plugin
    app:
      - name: example-studio/app-plugin-basic@0.0.1
      - name: example-studio/run-action-hook-plugin@0.0.2
    infra:
      - name: example-studio/infra-generates-sns@0.0.1
        actions:
          - name: example-studio/requires-sns-action@0.0.1
      - name: example-studio/infra-plugin-basic@0.0.1
      - name: example-studio/plugin-infra2108@0.0.3

actions

List of Actions present in your Stack.
They must be added with the syntax: - name: studio-slug/action-name@[semantic-version].

spec:
  docs:
    en-us: docs/en_us/docs.md
    pt-br: docs/pt_br/docs.md
  actions:
    - name: example-studio/action-basic@0.0.1
    - name: example-studio/action-with-connection@0.0.1
    - name: example-studio/requires-sns-action@0.0.1

starters

List of Starters present in your Stack. You must provide the path to the folder that contains the starter.yaml file.
For more details on Starter, see the starter.yaml file section or how to create a Starter.

spec:
  docs:
    en-us: docs/en_us/docs.md
    pt-br: docs/pt_br/docs.md
  starters:
    - path: starters/basic-starter

Example of a stack.yaml file