Criar Aplicação via STK CLI
Visão Geral
Na StackSpot, uma Aplicação é qualquer código-fonte que implementa regras de negócio, como classes, métodos, importações de bibliotecas ou o código de uma Aplicação minimamente funcional.
As Aplicações são desenvolvidas dentro dos Workspaces, utilizando ferramentas como Plugins, Stacks, Starters ou Workflows disponíveis, que tornam o desenvolvimento e a entrega de soluções mais rápidos e simples.
Não é possível criar uma Aplicação usando um Starter marcado como deprecated.
Na StackSpot, você pode criar Aplicações de duas formas:
- STK CLI; e
- Portal StackSpot EDP.
Para criar uma Aplicação, é necessário utilizar uma Stack e um Starter ou um Workflow.
A seguir, você confere o passo a passo para criar Aplicações pelo STK CLI utilizando Workflows.
Pré-requisitos
- Já ter o STK CLI instalado e ser membro de um Workspace.
- Estar logado em uma conta StackSpot no STK CLI.
- Acessar um Estúdio.
- Ter uma Stack com um Starter e um Workflow do tipo
createoustarter, criados e prontos para serem utilizados. - Já ter ambientes criados.
- Já ter configurado o Deployment via Self-Hosted Runtime para conectar os ambientes à Conta Cloud.
- Já ter um gerenciador de código-fonte (SCM – Source Code Management) configurado na organização, com SCM integrado.
- Verificar com o administrador da conta o gerenciamento do acesso ao SCM via PAT (Personal Access Token) do usuário ou da conta. Você deve configurá-lo em Conexões Externas.
Se você não atender a algum dos pré-requisitos mencionados, pause este guia e acesse o link correspondente ao requisito pendente para resolvê-lo antes de continuar.
Passo a Passo para Criar Aplicação pelo STK CLI com um Workflow
Passo 1. No seu terminal, selecione o Workspace que você quer utilizar para criar a Aplicação. Execute o comando:
stk use workspace
Os Workspaces da sua conta serão listados no terminal. Selecione o Workspace e pressione Enter.
Para conferir a lista de Workspaces disponíveis pelo terminal, execute o comando stk list workspace. O Workspace em que você está tem um asterisco.
Você também pode conferir no Portal da StackSpot, na seção Workspaces.
Passo 2. Para criar a Aplicação usando um Workflow, execute o comando:
Para os nomes de Estúdio, Stack e Workflow, sempre use o slug. O slug é o nome que está registrado no Portal da StackSpot EDP. O nome exibido pode ter alguma diferença do nome registrado, o que pode causar erros ao criar a Aplicação pelo STK CLI.
stk create app <NOME-APP> --workflow <SLUG-ESTUDIO>/<SLUG-STACK>/<SLUG-WORKFLOW>
Exemplo:
stk create app app-com-workflow --workflow nome-estudio/nome-stack/nome-workflow-create-app
- Se o argumento
--workflowfor fornecido, a CLI executará o Workflow especificado do tipocreateoustarter. - O Workflow será responsável por todas as etapas, incluindo aplicação de Plugins, configuração de inputs e qualquer lógica adicional definida no Workflow.
- Caso ambos os argumentos
--startere--workflowsejam fornecidos, a CLI retornará um erro, pois eles são mutuamente exclusivos.
Responda às perguntas do Workflow no terminal. Ao final da execução, sua Aplicação será criada.
Se você quiser criar a pasta (diretório) da Aplicação em um local diferente ou com um nome diferente, use o parâmetro --target ou -o.
Exemplo:
stk create app app-com-workflow \
--workflow nome-estudio/nome-stack/nome-workflow-create-app \
--target /home/user/Applications/my-app
Passo 3. Agora, registre sua Aplicação na sua conta StackSpot. Para isso, primeiro acesse o diretório da Aplicação:
cd <nome-da-aplicação>
Em seguida, execute o comando para registrar:
stk register app
Responda às perguntas:
- URL do repositório: informe o repositório que irá armazenar o código da sua Aplicação;
- Base branch: informe a branch que será utilizada no repositório.
Agora você pode conferir os dados da sua Aplicação dentro do seu Workspace no Portal da StackSpot, na seção Aplicações, e a execução do Workflow na seção Atividades.
Pronto, você criou e registrou sua Aplicação!
- O deploy da infraestrutura da Aplicação só é feito neste momento caso sua organização tenha configurado o deploy via Runtime Self-Hosted.
- Você deve fazer deploy da Aplicação em si por meio da sua pipeline ou de um Workflow do tipo deploy e executar o registro do deploy na Plataforma StackSpot EDP para poder acompanhar os logs dentro da tela de Atividades. Confira o processo na seção de Registro do deploy da Aplicação.