Pular para o conteúdo principal

Criar Action de Commit

Nesta seção, você encontra como criar uma Action no STK CLI.


Introdução

  • Nível intermediário

Este é um exemplo de como criar uma Action, para criar a sua própria Action, confira a página de Actions.

Pré-requisitos

stk login

Criar uma Action

Resumo dos passos:

Passo 1. Criar a Action

No seu terminal ou IDE de preferência, execute o comando:

stk create action

Responda às perguntas do comando no seu terminal:

  • ? Nomeie sua action: digite um nome para a sua Action.
  • ? Você deseja iniciar um repositório git (Y/n): opção para iniciar um repositório Git na pasta da Action. Para este exemplo, responda digitando n para não iniciar um repositório Git.
  • ? Adicionar remote? para este exemplo, responda digitando no.
  • ? Descrição da action: descreva a sua Action explicando o propósito.
  • ? Versão: digite o número da versão desejada para a sua Action. Ela deve estar no formato semântico, como no exemplo previamente preenchido no terminal 0.0.1.
  • ? Selecione o tipo de action: selecione o tipo de Action que você quer criar. Para este exemplo, selecione o tipo Shell.
  • ? Você gostaria de adicionar uma Connection Requerida (Y/n): opção para adicionar uma Connection Interface como requerida na Action. Para este exemplo, responda digitando n para não adicionar uma Connection Interface.

Use essa opção quando você precisar que a Action interaja com recursos de infraestrutura ou recursos Cloud durante a execução. Para mais informações sobre Connections Interfaces, consulte a documentação.

Após responder às perguntas, você receberá no terminal uma confirmação da criação da Action, como no exemplo:

? Nomeie sua action: commit-push-action
? Você deseja iniciar um repositório git (Y/n): no
? Descrição da action: This Action commits and pushes your changes to GitHub.
? Versão: (0.0.1)
? Selecione o tipo de action: Shell
? Você gostaria de adicionar uma Connection Requerida (Y/n): no
- Action commit-push-action criada com sucesso.
Cuidado!

A Action criada é apenas um modelo básico minimamente funcional.

Para seguir os próximos passos, edite todos os arquivos e opções usando os exemplos fornecidos ou os parâmetros que você deseja que a sua Action execute.

Passo 2. Editar os inputs da Action no action.yaml

A Action é criada com inputs de exemplo previamente preenchidos. Você precisa editar o arquivo action.yaml para editar e adicionar os inputs que serão utilizados pelo script da sua Action.

  • Acesse a pasta da Action que você criou e edite os inputs no arquivo action.yaml:

Os inputs a seguir são apenas um exemplo e fazem parte do guia para criar uma Action que faz commit/push no GitHub. Você pode criar a sua própria Action seguindo esse guia.

inputs:
  - label: Personal Access Token
    name: pat
    type: password
  - label: Organization Name
    name: org_name
    type: text
  - label: Repository Name
    name: repo_name
    type: text
  - label: Commit message
    name: message
    type: text

Para cada tipo de Action, existem opções onde você deve inserir os comandos ou scripts que serão executados pela Action. O exemplo a seguir demonstra comandos que podem ser executados na Action do tipo Shell. Você pode usá-los na sua Action ou digitar os comandos Shell que desejar.

Saiba mais sobre como preencher os campos de cada tipo de Action em Tipos de Action.

requirements-check:
  - check-command:
      linux: |
        git --version
      mac: |
        git --version
      windows: |
        git --version
    info: "Git not installed"
informação

Esse trecho da Action Shell serve para que o texto de info seja apresentado no terminal quando acontecer algum erro nesse comando.

  • Adicione os comandos no seu arquivo action.yaml de acordo com o seu sistema operacional. O trecho de código a seguir é apenas um exemplo; você pode usá-lo ou digitar os comandos que desejar:
script:
  linux: |
    git add .
    git commit -m "{{message}}"
    git push https://{{pat}}@github.com/{{org_name}}/{{repo_name}}
  mac: |
    git add .
    git commit -m "{{message}}"
    git push https://{{pat}}@github.com/{{org_name}}/{{repo_name}}
  windows: |
    git add .
    git commit -m "{{message}}"
    git push https://{{pat}}@github.com/{{org_name}}/{{repo_name}}

O exemplo adiciona, faz o commit e envia as suas alterações para um repositório remoto.

Dica!

Confira a indentação. Se ocorrer algum erro, provavelmente é por esse motivo.
O campo do script tem dois níveis de indentação.

Passo 3. Executar a Action localmente

Para executar a Action localmente como um teste, execute o comando com o caminho da pasta da Action:

stk run action <path-of-your-actions-folder>

Exemplo:

stk run action /Users/myteam/workspace/demo-action/commit-push-action

Ou acesse a pasta da Action e execute o comando:

stk run action .

Neste momento, a Action apresentará como perguntas os inputs que você adicionou no seu arquivo action.yaml. Você deve responder às perguntas para continuar. Considere os inputs de exemplo apresentados anteriormente e responda:

? Personal Access Token: adicione o seu PAT token
? Organization Name: adicione o nome da sua organização
? Repository Name: adicione o nome do seu repositório
? Commit message: commit-test

Passo 4. Publicar a Action no seu Estúdio

Não é obrigatório adicionar um repositório Git para publicar a sua Action.

Execute o comando na pasta da sua Action e informe o nome do seu Estúdio:

stk publish action

Você também pode informar diretamente no terminal o nome do Estúdio com a opção --studio, conforme o exemplo:

stk publish action --studio my-studio-name

Passo 5. Adicionar a Action na Stack

Siga os passos:

  1. No Portal da StackSpot, acesse o seu Estúdio;
  2. Clique na Stack que você criou anteriormente. No menu, clique em ‘Actions’;
  3. Clique em ‘Adicionar Actions’ e escolha a sua Action.

Passo 6. Publicar sua Stack

Agora você precisa publicar a sua Stack:

  1. Acesse o seu Estúdio no Portal da StackSpot;
  2. No menu, clique em ‘Stacks’;
  3. Clique no botão ‘Publicar’;

Você criou uma Action e publicou a Stack criada na seção Primeiro Passos: Criador.

O seu conteúdo está disponível para ser usado por você ou por outra pessoa.