Validar Stack

Nesta Página

Esta seção tem o objetivo de orientar na validação da sua Stack e na correção dos parâmetros que não passarem na validação.

Sobre validação de Stacks

A validação da Stack garante que todos os arquivos de configuração da sua Stack estejam de acordo com o que foi desenvolvido.

A validação é feita pelo comando stk-legacy validate, remove pastas vazias e valida se os campos da Stack foram preenchidos corretamente.

Você também tem a liberdade de definir os arquivos que devem ser ignorados para que não sejam incluídos na versão final da sua Stack. A validação irá considerar os arquivos cadastrados nos seguintes arquivos:

• .gitignore:
  É o arquivo presente em um repositório Git na raiz do seu projeto, onde você pode configurar quais arquivos vai ignorar ao enviar suas alterações para um repositório remoto.

• .stackignore:
  Semelhante ao .gitignore, presente na raiz da Stack, nesse arquivo você pode configurar quais arquivos serão ignorados na sua Stack para que eles não sejam utilizados.

Após a validação, você pode ter um retorno simplificado ou mais detalhado:

• O retorno simplificado da validação de uma Stack apresenta os sucessos e falhas da validação.
• O retorno detalhado da validação de uma Stack apresenta cada arquivo validado e o que foi ignorado.

Configurar arquivos ignorados

Os arquivos são ignorados antes da validação e dos testes serem executados. Você deve incluir no arquivo de configuração os arquivos que você deseja ignorar ao concluir o desenvolvimento da sua Stack.

Preecha os arquivos .gitignore e .stackignore com as pastas e arquivos que você deseja que sejam ignorados. Confira o exemplo a seguir:

Arquivos ignorados no .gitignore:

.gitignore

 # Dependencies
 /node_modules

 # Production
 /build

 # Generated files
 .myreactapp
 .cache-loader

 # Misc
 .DS_Store
 .env
 .env.local
 .env.development.local
 .env.test.local
 .env.production.local

 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*

Arquivos ignorados no .stackignore:

.stackignore

 # Test cases
 /test

 # Documentation
 /docs
 *.md

 # Generated files
 *.png
 *.jpeg
 /template-test*   

Lista de campos validados

A lista abaixo apresenta todos os parâmetros validados do arquivo de configuração da sua Stack: o arquivo stack.yaml, todos os arquivos plugin.yaml e template.yaml. Se algum erro ocorrer na validação da sua Stack, confira abaixo como cada campo deve estar preenchido:

Validação do stack.yaml

description

Atributo	Valor aceito
type	string
minlength	0
maxlength	500
required	false

name

Atributo	Valor aceito
type	string
minlength	0
maxlength	100
required	true
empty	false
regex	^([a-z][a-z0-9]*)(-[a-z0-9]+)*$

display-name

Atributo	Valor aceito
type	string
minlength	0
maxlength	100
required	false

picture

Atributo	Valor aceito
type	string
minlength	0
maxlength	200
required	false

category

Atributo	Valor aceito
type	string
required	false
check_with	check_categories

compatibility

Atributo	Valor aceito
type	list
required	false

technologies

Atributo	Valor aceito
type	list
check_with	check_technologies
required	false

about

about
Atributo	Valor aceito
type	string
required	false
regex	.+\.md

use-cases

Atributo	Valor aceito
type	list
required	false
schema	dict
title
Atributo	Valor aceito
type	string
minlength	0
maxlength	200
required	true
empty	false
content
Atributo	Valor aceito
type	string
regex	.+\.md
required	true
empty	false
stackfile
Atributo	Valor aceito
type	string
required	true
empty	false
regex	.+.\\(yaml|yml)

Validação do template.yaml

description

Atributo	Valor aceito
type	string
minlength	0
maxlength	500
required	false

name

Atributo	Valor aceito
type	string
minlength	0
maxlength	100
required	true
empty	false
regex	'^([a-z][a-z0-9]*)(-[a-z0-9]+)*$'

display-name

Atributo	Valor aceito
type	string
minlength	0
maxlength	100
required	false

types

Atributo	Valor aceito
type	list
required	false
check_with	check_template_types

picture

Atributo	Valor aceito
type	string
minlength	0
maxlength	200
required	false

category

Atributo	Valor aceito
type	string
required	false
check_with	check_categories

compatibility

Atributo	Valor aceito
type	list
required	false

about

Atributo	Valor aceito
type	string
required	false
regex	.+\.md

usage

Atributo	Valor aceito
type	string
required	false
regex	.+\.md

use-case

Atributo	Valor aceito
type	string
required	false
regex	.+\.md

implementation

Atributo	Valor aceito
type	string
required	false
regex	.+\.md

Validação do plugin.yaml

description

Atributo	Valor aceito
type	string
minlength	0
maxlength	500
required	false

name

Atributo	Valor aceito
type	string
minlength	0
maxlength	100
required	true
empty	false
regex	'^([a-z][a-z0-9]*)(-[a-z0-9]+)*$'

display-name

Atributo	Valor aceito
type	string
minlength	0
maxlength	100
required	false

types

Atributo	Valor aceito
type	list
required	false
check_with	check_plugin_types

picture

Atributo	Valor aceito
type	string
minlength	0
maxlength	200
required	false

category

Atributo	Valor aceito
type	string
required	false
check_with	check_categories

compatibility

Atributo	Valor aceito
type	list
required	false

technologies

Atributo	Valor aceito
type	list
check_with	check_technologies
required	false

about

Atributo	Valor aceito
type	string
required	false
regex	.+\.md

usage

Atributo	Valor aceito
type	string
required	false
regex	.+\.md

use-case

Atributo	Valor aceito
type	string
required	false
regex	.+\.md

implementation

Atributo	Valor aceito
type	string
required	false
regex	.+\.md