stack.yaml

Exemplo de um arquivo `stack.yaml`

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

Atributos da Stack

`schema-version`

Versão do schema do manifesto.

schema-version: v1

`kind`

Tipo do manifesto.

kind: stack

`metadata`

Metadados de identificação da Stack. Contém os seguintes atributos:

name

Identificador técnico (slug) da Stack. Deve ser único dentro do Estúdio e usar kebab-case.

name: stack-name-example

display-name

Nome amigável que será exibido no Portal para representar a Stack.

display-name: stack-display-name-example

description

Descrição da Stack. A descrição precisa ter, no mínimo, três caracteres e, no máximo, 500 caracteres.

description: Stack example

version

Versão da Stack. Segue o versionamento semântico (SemVer).

version: 1.0.0

`spec`

Especificação técnica da Stack.

docs

Arquivos Markdown com a documentação da Stack. Pelo menos um dos idiomas deve ser adicionado.

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

links

Lista de links estáticos e dinâmicos relacionados à Stack. Os links ficam visíveis nas Stacks publicadas na StackSpot.
Os links são semelhantes aos adicionados nos Plugins, para mais detalhes consulte como adicionar links em 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

Lista de Plugins presentes na Stack. Organizados por tipo app (Aplicação) e infra (Infraestrutura).
Devem ser adicionados com a sintaxe: - name: studio-slug/plugin-name@[semantic-version].

Para associar Actions em Plugins de infra, use a sintaxe: - name: studio-slug/action-name@[semantic-version].
Para saber mais, consulte como associar Actions em Plugins de infra.

Atenção!

Plugins são propriedades obrigatórias nas Stacks. Pelo menos um Plugin do tipo app ou infra deve ser adicionado.

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

Lista de Actions presentes na Stack.
Devem ser adicionadas com a sintaxe: - 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

Lista de Starters presentes na Stack. Você deve informar o caminho da pasta que contém o arquivo starter.yaml.
Para mais detalhes do Starter, consulte a seção do arquivo starter.yaml ou como criar o Starter.

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

Exemplo de um arquivo stack.yaml