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`

This is what identifies Stack. They are of type string:

name

Name of the Stack that will be displayed on the Portal. When you do not name, the previously entered name will be displayed. Use a kebab case.

- name: stack-name-example.

display-name

Name of the Stack that will be displayed on the Portal. When you do not name, the previously entered name will be displayed.

- display-name: stack-display-name-example.

description

Stack Description. The description must have a minimum of three characters and a maximum of 500.

- description: Stack example.

version

Stack version. Semantic Versioning (SemVer) follows.

- version: 1.0.0

`spec`

It's the Stack specification. They are of type string:

docs

Markdown with Stack documentation. At least one of the languages must be added.

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

links

List of static and dynamic links. 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. Separated by types app and infra, they must be added with the syntax: - name: studio-slug/plugin-name@[semantic-version].

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

warning

Plugins are properties required 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
     below:
       - 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

Starter present in your Stack. You must provide the path to the starter.yaml file. For more details on Starter, see the starter.yaml file section or [how to create Stater] (guides/studio-guides/create-stack-starter-cli.md).

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