stk create plugin

Nesta seção, você encontra mais informações sobre o comando ‘stk create plugin’.

Descrição

O comando stk create plugin permite criar novos Plugins para a StackSpot.

Como Funciona?

Quando você roda o comando no terminal dentro da pasta de uma Stack, uma sub-pasta é gerada com a estrutura para criar o Plugin. O usuário deve editar o arquivo plugin.yaml e configurar os parâmetros de entrada do Plugin.

Criar plugins em repositórios separados

Se você quiser criar um Plugin separado de uma Stack para poder ser usado em mais de uma Stack, execute o comando no terminal fora da pasta de uma Stack. Depois disso, uma pasta é gerada com a estrutura para criar o Plugin.

Esta pasta será inicializada como um repositório Git.

O usuário deve editar o arquivo plugin.yaml e configurar os parâmetros de entrada do Plugin.

Parâmetros

Confira as opções disponíveis no comando:

ParâmetroDescrição
NAMEDefine o nome do Plugin criado. Se o nome não for informado, é definido o nome do repositório do parâmetro --remote.
--descriptionÉ o texto que descreve o Plugin e a sua finalidade. Esta descrição também será exibida no comando stk list plugin para que o usuário saiba sobre o Plugin
--remoteÉ um parâmetro que define a URL remota do repositório Git, que será usada como origin para o Plugin. Se o usuário não informar o remote, será preciso executar o git add remote para conseguir publicar o Plugin no Git. (Você deve utilizar apenas se estiver usando repositórios separados para Plugins.)

Parâmetros Depreciados

ParâmetroDescrição
--typesDefine os tipos do plugin. O plugin pode ser aplicado em uma stack criada com stk create app, stk create env ou nos dois. Se for aplicado nesta última, os valores para isso são: app e env. Para definir mais de um tipo de plugin, use uma vírgula.
--deployAdiciona uma seção de ciclo de vida no plugin.yaml, onde você pode definir os comandos executados pelo stk deploy do STK CLI.

Exemplo de criação de um plugin app

Leia também