Usar conteúdo sem Workspace
Nesta seção, você encontra um guia de como criar, aplicar Plugins e executar Actions fora de um Workspace.
Você pode usar conteúdos publicados no seu Estúdio sem estar com um Workspace ativo para criar Aplicações localmente em sua máquina, aplicar Plugins e executar Actions. Dessa forma, é possível testar localmente as Aplicações, Actions e Plugins antes de utilizá-los dentro de um Workspace.
Pré-requisitos
- Acesso a um Estúdio;
- Possuir Actions, Plugins e Stacks no Estúdio utilizado.
Todos os passos a seguir são feitos na STK CLI. Como todas as ações serão executadas fora de um Workspace, você deve acessar a sua conta StackSpot para obter o nome e a versão da Stack, Plugin, Action e o nome do Estúdio utilizado.
Criar Aplicação fora do Workspace
Passo 1. Acessar Starter em seu Estúdio
- Após o login, selecione 'Estúdios' e acesse o Estúdio desejado;
- No menu lateral, acesse a opção 'Stacks' para visualizar as Stacks dentro do Estúdio;
- Na página da Stack, clique em 'Starters' e, em seguida, clique no Starter da Stack;
- Depois do nome do Starter, copie o código do comando para criar a sua Aplicação.
O código copiado contém:
# informe 'app-name', 'studio-name', 'stack-name' e 'starter-name' sem as chaves
stk create app {app-name} --starter {studio-name}/{stack-name}/{starter-name}
Exemplo:
O comando obtido será:
stk create app {app-name} --starter technical-writers/react-website-template/install-site-template
Passo 2. Executar comando para criar a Aplicação
- Abra o terminal e faça o login na sua conta. Execute o comando stk login;
- Caso esteja logado em sua conta, certifique-se de não estar com nenhum Workspace ativo. Execute o comando stk exit workspace:
stk exit workspace
- Para criar a sua Aplicação, execute o comando obtido no Passo 1:
Substitua o
{app-name}por um nome para a sua Aplicação, insira o texto sem chaves.
# informe 'app-name', 'studio-name', 'stack-name' e 'starter-name' sem as chaves
stk create app {app-name} --starter {studio-name}/{stack-name}/{starter-name}
Exemplo:
stk create app react-site-test --starter technical-writers/react-website-template/install-site-template
Se você quiser usar outra versão publicada de uma Stack, após o nome da Stack informe a versão desejada nesse formato: stack-name@version-number. Caso contrário, será sempre utilizada a última versão publicada.
# informe 'app-name', 'studio-name', 'stack-name@version' e 'starter-name' sem as chaves
stk create app {app-name} --starter {studio-name}/{stack-name@1.0.0}/{starter-name}
Confira o exemplo:
stk create app react-site-test --starter technical-writers/react-website-template@1.0.0/install-site-template
Após executar o comando, o terminal mostra o Estúdio, a Stack com a sua versão atual e o Starter utilizado.
? Name your application react-site-test
? Do you want to init a git repository? No
? App description: (Describe your app explaining its purpose)
> Fetching stacks info of account 'stk-techwriters'.
? Select the studio: technical-writers
? Select the stack: react-website-template@3.1.0
? Select the starter: install-site-template
> Creating app outside workspace.
> Fetching starter info.
Em seguida, são instalados os Plugins do Starter. Preencha os inputs, se houver, e, após isso, a sua Aplicação é criada na pasta atual.
Uso isolado de Plugins
Ao aplicar Plugins de Infraestrutura, são criados Connectors a partir das Connection Interfaces que o Plugin deve gerar. Você deve usar um alias para esses Connectors ao aplicar os Plugins de Infraestrutura, e eles devem seguir as seguintes regras:
- O alias não deve existir em seu arquivo yaml atual da Aplicação ou Infraestrutura;
- O alias não deve ter o mesmo nome de um Connector que existe em sua conta;
- O alias deve respeitar a seguinte expressão regular, em que o tamanho mínimo é de 2 caracteres e o máximo é de 50 caracteres:
((^(?!^\d+$)[a-z\d]{2,})(-[a-z\d]+)*$).
1. Aplicar Plugin Local
Logo após criar um Plugin, é possível aplicá-lo para testar seu comportamento e checar os arquivos gerados. Para isso, crie uma nova pasta e execute dentro dela o comando:
# informe o caminho absoluto da pasta do plugin sem as chaves
stk apply plugin {plugin-absolute-path}
Exemplo:
Considere um Plugin no seguinte caminho: /Users/stk.techwriters/personal-plugins/doc-template-plugin. O comando deve ser executado da seguinte maneira:
stk apply plugin /Users/stk.techwriters/personal-plugins/doc-template-plugin
Depois disso, preencha no terminal todos os inputs solicitados na aplicação do Plugin. Os arquivos do Plugin são gerados na pasta atual.
2. Aplicar Plugin sem Workspace
Para aplicar um Plugin sem Workspace, crie uma nova pasta e execute dentro dela os comandos:
- Abra o terminal e faça o login na sua conta. Execute o comando stk login;
- Caso esteja logado em sua conta, certifique-se de não estar com nenhum Workspace ativo. Execute o comando stk exit workspace:
stk exit workspace
- Execute o comando stk apply plugin como no exemplo a seguir:
# informe 'studio-name', 'plugin-name' e 'version-number' sem as chaves
stk apply plugin {studio-name}/{plugin-name}@{version-number}
Exemplo:
stk apply plugin technical-writers/doc-template-app@3.0.0
Depois disso, preencha no terminal todos os inputs solicitados na aplicação do Plugin. Os arquivos do Plugin são gerados na pasta atual.
Uso isolado de Actions
Executar Action local
Logo após criar uma Action, é possível executá-la para testar seu comportamento e checar os arquivos gerados. Para executar a Action, use um dos comandos:
# informe o caminho absoluto da pasta da action sem as chaves
stk run action {action-absolute-path}
Ou dentro da pasta da Action:
# execute o comando dentro da pasta da action
stk run action .
Exemplo:
Considere uma Action no seguinte caminho: /Users/stk.techwriters/personal-actions/install-node-action. O comando deve ser executado da seguinte maneira:
stk run action /Users/stk.techwriters/personal-actions/install-node-action
Você também pode acessar a pasta da Action e executar o comando dentro dessa pasta:
stk run action .
Depois disso, preencha no terminal todos os inputs solicitados na execução da Action.
Executar Action sem Workspace
Para executar uma Action sem Workspace, faça o login na sua conta e certifique-se de não estar com um Workspace ativo:
- Abra o terminal, faça o login na sua conta e execute o comando stk login;
- Caso esteja logado em sua conta, certifique-se de não estar com nenhum Workspace ativo. Execute o comando stk exit workspace:
stk exit workspace
- Execute o comando stk run action, informando o nome do Estúdio, o nome da Stack, o número da versão e o nome da Action:
# informe 'studio-name', 'stack-name', 'version-number' e 'action-name' sem as chaves
stk run action {studio-name}/{stack-name}@{version-number}/{action-name}
Exemplo:
stk run action technical-writers/react-doc-template@2.1.0/install-node-action
Depois disso, preencha no terminal todos os inputs solicitados na execução da Action.
Próximos passos
- Crie Aplicações em seu Workspace.
- Adicione Actions em suas Stacks.