Stack and Starter creation and configuration via the CLI

This release note is written in English and Portuguese, scroll to the end to access both languages.

Esta release note está escrita em Inglês e Português, role a página até o final para ter acesso às duas linguagens.

---

Content creators can now create and configure Stack and Starter via the CLI channel.

What is Stack and Starter creation and configuration via the CLI and its benefits?

From this implementation, content creators can create and configure their stacks and starters through the CLI. For content creators, this new functionality benefits them by allowing them to create and configure stacks and starters through the CLI and not just through the portal as it was before this implementation. With this, we meet the needs of customers who prefer to create their content through lines of code, thus providing an experience where both product channels have the same functionalities.

How it works?

To create a stack via the CLI:

1 - Enter the command:

stk create stack 

2 - Answer the questions on your terminal:

? Name your stack: example-stack ? Version: (0.0.1) ? Do you want to start a git repository? At the ? Add remote? Yes? Git URL to set as remote origin: add the URL? Stack description: (Describe the stack explaining its purpose)

3 - Open the Stack folder. Click on the stack.yaml file and fill in the Stack parameters:

• repository
• docs
• links
• plugins
  -actions
• starters

stack.yaml example:

schema-version: v1
kind: stack
metadata:
  name: my-stack
  display-name: my-stack
  description: My Stack description
  version: 1.0.0
spec:
  repository: [email protected]:GitHub-UserName/my-local-repository.git
  docs:
    en-us: docs/en_us/docs.md
    pt-br: docs/pt_br/docs.md
  links:
    - name: My Stack link
      url: https://github.com/my-github-org/my-stack
      picture: stack-image.png
  plugins:
    app:
      - name: studio-slug/[email protected]
    infra:
      - name: studio-slug/[email protected]
  actions:
    - name: studio-slug/[email protected]
    - name: studio-slug/[email protected]
    - name: studio-slug/[email protected]
  starters:
    - name: starter-name
      path: starters/basic-starter 
    - name: java-starter
      path: starters/java-starter  

To create a starter via the CLI:

1 - Run the command:

stk create starter

2 - Answer the questions on your terminal:

? Name your starter: basic-starter ? Do you want to start a git repository? Yes/No? Add remote? Yes/No? Git URL to set as remote origin: add the URL? Description of the starter: (Describe the starter explaining its purpose)

Make sure you have added the Starter name to your stack.yaml file.

3 - Open the Stack folder and then open the Starter folder. Click on the starter.yaml file and fill in the Starter parameters:

• type
• docs
• plugins

Example starter.yaml:

schema-version: v1
kind: starter
metadata:
  name: basic-starter
  description: basic-starter
spec:
  type: app
  docs:
    en-us: docs/en_us/docs.md
    pt-br: docs/pt_br/docs.md
  plugins:
    required:
      - name: my-studio/app-java-plugin  

To publish the stack:

1 - Run the command:

stk publish stack

2 - Select your Studio and click "Enter", or enter the name of the Studio with the option --studio.

stk publish stack --studio <slug studio>

Ready! Your Stack and Starter has been published. You can check out the publication by accessing the stackspot.com portal.

Supporting content

Documentation

---

Os criadores de conteúdo agora podem criar e configurar Stack e Starter pelo canal CLI.

O que é Stack and Starter creation and configuration via the CLI e seus benefícios?

A partir dessa implementação os criadores de conteúdo podem criar e configurar suas stacks e starters por meio da CLI. Para os criadores de conteúdo, esta nova funcionalidade os beneficia por permitir criar e configurar stacks e starter por meio da CLI e não apenas por meio do portal como era antes dessa implementação. Com isso, atendemos às necessidades dos clientes que preferem criar seus conteúdos através de linhas de código, proporcionando assim uma experiência onde ambos os canais do produto possuem as mesmas funcionalidades.

Como funciona?

Para criar uma stack pela CLI:

1 - Insira o comando:

stk create stack 

2 - Responda as perguntas no seu terminal:

? Nomeie sua stack: exemplo-stack ? Versão: (0.0.1) ? Você deseja iniciar um repositório git? No ? Adicionar remote? Yes ? Git URL para definir como remote origin: adicione a URL ? Descrição da stack: (Descreva a stack explicando o seu propósito)

3 - Abra a pasta da Stack. Clique no arquivo stack.yaml e preencha os parâmetros da Stack:

• repository
• docs
• links
• plugins
• actions
• starters

Exemplo stack.yaml:

schema-version: v1
kind: stack
metadata:
  name: my-stack
  display-name: my-stack
  description: My Stack description
  version: 1.0.0
spec:
  repository: [email protected]:GitHub-UserName/my-local-repository.git
  docs:
    en-us: docs/en_us/docs.md
    pt-br: docs/pt_br/docs.md
  links:
    - name: My Stack link
      url: https://github.com/my-github-org/my-stack
      picture: stack-image.png
  plugins:
    app:
      - name: studio-slug/[email protected]
    infra:
      - name: studio-slug/[email protected]
  actions:
    - name: studio-slug/[email protected]
    - name: studio-slug/[email protected]
    - name: studio-slug/[email protected]
  starters:
    - name: starter-name
      path: starters/basic-starter 
    - name: java-starter
      path: starters/java-starter  

Para criar um starter pela CLI:

1 - Execute o comando:

stk create starter

2 - Responda as perguntas no seu terminal:

? Nomeie seu starter: basic-starter ? Você deseja iniciar um repositório git? Yes/No ? Adicionar remote? Yes/No ? Git URL para definir como remote origin: adicione a URL ? Descrição da starter: (Descreva o starter explicando o seu propósito)

Certifique-se de ter adicionado o nome do Starter ao seu arquivo stack.yaml.

3 - Abra a pasta da Stack e, em seguida, abra a pasta do Starter. Clique no arquivo starter.yaml e preencha os parâmetros do Starter:

• type
• docs
• plugins

Exemplo starter.yaml:

schema-version: v1
kind: starter
metadata:
  name: basic-starter
  description: basic-starter
spec:
  type: app
  docs:
    en-us: docs/en_us/docs.md
    pt-br: docs/pt_br/docs.md
  plugins:
    required:
      - name: my-studio/app-java-plugin  

Para publicar a stack:

1 - Execute o comando:

stk publish stack

2 - Selecione seu Estúdio e clique em "Enter", ou informe o nome do Estúdio com a opção --studio.

stk publish stack --studio <slug studio>

Pronto! Sua Stack e seu Starter foi publicado. Você pode conferir a publicação acessando o portal stackspot.com.

Conteúdos de apoio

Documentação