Criar um Workflow do tipo Create chamando um Workflow Starter

Nesta página, você encontra um exemplo detalhado de como criar um Workflow do tipo Create que chama um Workflow do tipo Starter utilizando o STK CLI da StackSpot.

Pré-requisitos

Antes de iniciar, confirme se você possui:

Conta na StackSpot com permissão de Content Creator.
STK CLI instalado e atualizado. Certifique-se de ter a versão mais recente executando stk --version.
Acesso a um Estúdio na StackSpot.
Workflow Starter já criado e publicado no seu Estúdio.
Diretório local para criar o novo Workflow.

Passo 1. Criar o Workflow do tipo `create`

1.1. Acesse o terminal

Navegue até o diretório onde deseja criar o Workflow.

cd <seu-diretorio>

1.2. Execute o comando de criação

Execute o comando a seguir:

stk create workflow

1.3. Responda às perguntas do terminal

Nome do Workflow: use nomes claros, sem espaços, preferencialmente em inglês e no padrão kebab-case, por exemplo: workflow-with-multiple-sleeps-create.
Descrição: descreva resumidamente o objetivo do Workflow. Exemplo: Workflow with multiple sleeps.
Tipo do Workflow: digite create para indicar que este Workflow será usado para criação de recursos/aplicações.

1.4. Estrutura gerada

O comando acima cria um diretório com o nome do Workflow e arquivos, como por exemplo:

workflow.yaml (configuração principal)
Pasta docs/ com documentação em inglês e português

Passo 2. Estruturar o Arquivo workflow.yaml

2.1. Abra o arquivo workflow.yaml

No editor de sua preferência (por exemplo, VSCode) execute:

cd workflow-with-multiple-sleeps-create
code workflow.yaml

2.2. Estruture o YAML para chamar o Workflow Starter

Substitua ou ajuste o conteúdo conforme o exemplo a seguir:

schema-version: v1
kind: workflow
metadata:
  name: example-multi-step-create
  display-name: Example Multi-step Create
  description: "Exemplo fictício de um workflow com múltiplos steps."
  version: 0.1.0
spec:
  type: create
  label: "Exemplo de Workflow"
  targets:
    - infra
  docs:
    en-us: docs/en_us/docs.md
    pt-br: docs/pt_br/docs.md
  inputs:
    - label: "Nome do Usuário"
      type: string
      name: user_name
    - label: "Idade do Usuário"
      type: string
      name: user_age
    - label: "Token de Acesso"
      type: password
      name: access_token
  jobs:
    - id: job_run_starter_workflow
      label: "Executa o Starter Workflow"
      steps:
        - id: run_starter_workflow
          type: workflow
          name: fictitious-studio/example-starter-workflow@0.1.0
          inputs:
            user_name: "{{ user_name }}"
            user_age: "{{ user_age }}"
            access_token: "{{ access_token }}"

Cuidado!

O campo name do step deve seguir o padrão: studio-name/workflow-name@version.
Os campos em inputs devem ter os mesmos nomes e tipos usados no Workflow Starter.
O step do tipo workflow permite encadear Workflows, tornando o processo modular e reutilizável.

2.3. Valide os campos

Confira se os campos obrigatórios estão presentes.
Revise as versões (@1.0.0) para garantir que está usando o Workflow Starter correto.
Caso necessário, adicione ou remova inputs de acordo com a interface do Workflow Starter.

Passo 3. Testar o Workflow localmente

3.1. Execute o Workflow em modo local

No terminal, na pasta do Workflow:

stk run workflow

3.2. Preencha os Inputs solicitados

O CLI solicitará os valores dos campos definidos no YAML:

? Nome: João
? Idade: 30
? PAT: ***********

Dica!

Use valores reais para simular um cenário próximo ao de produção.
O campo PAT é do tipo password: o valor não será exibido ao digitar.

3.3. Analise os logs

Acompanhe a execução e verifique a saída no terminal. Confira se não há erros e que o Workflow Starter foi chamado corretamente.

3.4. Depuração

Caso ocorra algum erro:

Leia a mensagem de erro atentamente.
Revise os inputs e o nome do Workflow Starter.
Corrija o YAML e repita o teste.

Passo 4. Publicar o Workflow

4.1. Execute o comando de publicação

Quando o teste local estiver correto, publique o Workflow no Estúdio executando o comando a seguir:

stk publish workflow --studio <nome-do-seu-estudio>

Exemplo: se o nome do seu estúdio for my-studio, use: stk publish workflow --studio my-studio

4.2. Verifique a publicação

Acesse o Portal da StackSpot;
Confirme se o novo Workflow está listado no seu Estúdio;
Compartilhe com o seu time e defina permissões, se necessário.