Conceitos básicos de esquemas personalizados
Durante o processo de criação de um esquema, você pode configurar o esquema e gerar uma prévia dos recursos do projeto. Cada esquema personalizado é gerenciado por um projeto do CodeCatalyst, que contém um fluxo de trabalho por padrão para publicação no catálogo de esquemas do espaço.
Ao configurar os detalhes do esquema personalizado, você também pode optar por armazenar o código-fonte do esquema em um repositório de terceiros, onde ainda é possível gerenciar o esquema personalizado e utilizar os recursos de gerenciamento do ciclo de vida para manter os projetos do seu espaço sincronizados quando o esquema personalizado é modificado. Para ter mais informações, consulte Adicionar funcionalidade a projetos com extensões no CodeCatalyst e Trabalho com o gerenciamento do ciclo de vida como autor do esquema.
Se você já tem um repositório de origem com padronização e práticas recomendadas em vigor, pode optar por converter esse repositório de origem em um esquema personalizado. Para ter mais informações, consulte Converter repositórios de origem em esquemas personalizados.
Tópicos
Pré-requisitos
Antes de criar um esquema personalizado, pense nos seguintes requisitos:
Seu espaço no CodeCatalyst deve ser do nível Enterprise. Para ter mais informações, consulte Managing billing no Guia do administrador do Amazon CodeCatalyst.
Você precisa ter o perfil Administrador do espaço ou Usuário avançado para criar esquemas personalizados. Para ter mais informações, consulte Concessão de acesso com perfis de usuário.
Etapa 1: criar um esquema personalizado no CodeCatalyst
Quando você cria um esquema personalizado a partir das configurações do seu espaço, um repositório é criado. O repositório inclui todos os recursos necessários para desenvolver seu esquema antes de publicá-lo no catálogo de esquemas do espaço.
Para criar um esquema personalizado
Abra o console do CodeCatalyst em https://codecatalyst.aws/
. No console do CodeCatalyst, navegue até o espaço onde você deseja criar um esquema personalizado.
No painel do espaço, escolha a guia Configurações e Esquemas.
Escolha Criar esquema.
Em Nomear seu esquema, insira o nome que você deseja atribuir ao seu projeto e os nomes dos recursos associados. O nome deve ser exclusivo em seu espaço.
-
(Opcional) Por padrão, o código-fonte criado pelo esquema é armazenado em um repositório do CodeCatalyst. Também é possível armazenar o código-fonte do esquema em um repositório de terceiros. Para ter mais informações, consulte Adicionar funcionalidade a projetos com extensões no CodeCatalyst.
Realize um destes procedimentos, dependendo do provedor de repositório de terceiros que você deseja usar:
-
Repositórios do GitHub: conecte uma conta do GitHub.
Escolha o menu suspenso Avançado, selecione GitHub como provedor do repositório e, depois, selecione a conta do GitHub na qual você deseja armazenar o código-fonte criado pelo esquema.
nota
Se você estiver usando uma conexão com uma conta do GitHub, deverá criar uma conexão pessoal para estabelecer o mapeamento entre sua identidade do CodeCatalyst e sua identidade do GitHub. Para ter mais informações, consulte Conexões pessoais e Acesso a recursos do GitHub com conexões pessoais.
-
Repositórios do Bitbucket: conecte um espaço de trabalho do Bitbucket.
Escolha o menu suspenso Avançado, selecione Bitbucket como provedor do repositório e, depois, escolha o espaço de trabalho do Bitbucket em que você deseja armazenar o código-fonte criado pelo esquema.
-
Repositórios do GitLab: conecte um usuário do GitLab.
Escolha o menu suspenso Avançado, selecione GitLab como provedor do repositório e, depois, escolha o usuário do GitLab no qual você deseja armazenar o código-fonte criado pelo esquema.
-
-
Em Detalhes do esquema, faça o seguinte:
No campo de entrada de texto Nome de exibição do esquema, insira um nome que aparecerá no catálogo de esquemas do espaço.
No campo de entrada de texto Descrição, insira uma descrição para seu esquema personalizado.
No campo de entrada de texto Nome do autor, insira um nome de autor para seu esquema personalizado.
-
(Opcional) Escolha as Configurações avançadas.
Selecione + Adicionar para adicionar tags que são adicionadas ao arquivo
package.json.Escolha o menu suspenso Licença e, depois, escolha uma licença para seu esquema personalizado.
No campo de entrada de texto Nome do pacote do esquema, insira um nome para identificar seu pacote do esquema.
Por padrão, um fluxo de trabalho de lançamento é gerado usando um esquema de publicação em seu projeto chamado Blueprint Builder. O fluxo de trabalho publica a versão mais recente do esquema em seu espaço quando você envia alterações, já que as permissões de publicação são habilitadas pelo fluxo de trabalho de lançamento. Para desativar a geração do fluxo de trabalho, desmarque a caixa de seleção Fluxo de trabalho de lançamento.
(Opcional) Um projeto de esquema vem com código predefinido para apoiar a publicação do esquema no catálogo do espaço. Para visualizar arquivos de definição com atualizações com base nas seleções de parâmetros do projeto que você fez, selecione Visualizar código ou Visualizar fluxo de trabalho em Gerar visualização do esquema.
Escolha Criar esquema.
Se você não desativou a geração do fluxo de trabalho para seu esquema personalizado, o fluxo de trabalho começa a ser executado automaticamente quando o esquema é criado. Quando a execução do fluxo de trabalho estiver concluída, seu esquema personalizado estará disponível para ser adicionado ao catálogo de esquemas do espaço por padrão. Você pode desativar as permissões de publicação se não quiser que a versão mais recente do esquema seja publicada automaticamente no espaço. Para ter mais informações, consulte Definição de permissões de publicação para um esquema personalizado e Execução de um fluxo de trabalho.
Como o fluxo de trabalho de publicação chamado blueprint-release é criado usando um esquema, o esquema pode ser encontrado como um esquema aplicado em seu projeto. Para ter mais informações, consulte Adicionar um esquema a um projeto para integrar recursos e Desassociar um esquema de um projeto para interromper as atualizações.
Etapa 2: desenvolver um esquema personalizado com componentes
Um assistente de esquema é gerado quando você cria um esquema personalizado e pode ser modificado com componentes ao desenvolver o esquema personalizado. Você pode atualizar os arquivos src/blueprints.js e src/defaults.json para modificar o assistente.
Importante
Se você quiser usar pacotes de esquema de fontes externas, considere os riscos que podem vir com esses pacotes. Você é responsável pelos esquemas personalizados que adiciona ao seu espaço e pelo código que eles geram.
Crie um Ambiente de Desenvolvimento em seu projeto do CodeCatalyst com um ambiente de desenvolvimento integrado (IDE) compatível antes de configurar o código do esquema. É necessário um Ambiente de Desenvolvimento para trabalhar com as ferramentas e os pacotes necessários.
Como criar um ambiente de desenvolvimento
-
No painel de navegação, execute uma das seguintes opções:
Selecione Visão geral e navegue até a seção Meus ambientes de desenvolvimento.
Selecione Código e, depois, escolha Ambientes de Desenvolvimento.
Selecione Código, selecione Repositórios de origem e escolha o repositório que você criou ao criar o esquema.
Escolha Criar ambiente de desenvolvimento.
Selecione um IDE compatível no menu suspenso. Consulte Ambientes de desenvolvimento integrados compatíveis para ambientes de desenvolvimento para ter mais informações.
Selecione Trabalhar na ramificação existente e, no menu suspenso Ramificação existente, escolha a ramificação do recurso que você criou.
(Opcional) No campo de entrada de texto Alias - opcional, insira um alias para identificar o Ambiente de Desenvolvimento.
Escolha Criar. Enquanto seu Ambiente de Desenvolvimento estiver sendo criado, a coluna de status do Ambiente de Desenvolvimento exibirá Iniciando e a coluna de status exibirá Executando após a criação do Ambiente de Desenvolvimento.
Para ter mais informações, consulte Escrever e modificar código com ambientes de desenvolvimento no CodeCatalyst.
Para desenvolver seu esquema personalizado
-
Em um terminal em funcionamento, use o seguinte comando
yarnpara instalar dependências:yarnAs ferramentas e os pacotes necessários são disponibilizados por meio do Ambiente de Desenvolvimento do CodeCatalyst, incluindo o Yarn. Se você estiver trabalhando em um esquema personalizado sem um Ambiente de Desenvolvimento, instale primeiro o Yarn em seu sistema. Para ter mais informações, consulte a documentação de instalação do Yarn
. -
Desenvolva seu esquema personalizado para que ele seja configurado de acordo com suas preferências. Você pode modificar o assistente do esquema adicionando componentes. Para ter mais informações, consulte Desenvolvimento de um esquema personalizado para satisfazer os requisitos do projeto, Modificar os recursos do esquema com um assistente de frontend e Publicação de um esquema personalizado em um espaço.
Etapa 3: visualizar um esquema personalizado
Depois de configurar e desenvolver seu esquema personalizado, você pode visualizar e publicar a versão prévia do esquema no espaço. Uma versão prévia permite verificar se o esquema é o que você deseja antes de ser usado para criar novos projetos ou aplicado a projetos existentes.
Para visualizar um esquema personalizado
-
Em um terminal em funcionamento, use o seguinte comando
yarn:yarn blueprint:preview -
Navegue até o link
See this blueprint at:fornecido para visualizar seu esquema personalizado. Confira se a interface do usuário, inclusive o texto, aparece conforme o esperado com base na configuração. Se quiser alterar o esquema personalizado, você pode editar o arquivo
blueprint.ts, ressintetizar o esquema e, depois, publicar uma versão prévia novamente. Para ter mais informações, consulte Ressíntese.
(Opcional) Etapa 4: publicar uma versão prévia do esquema personalizado
Você pode publicar uma versão prévia do esquema personalizado no espaço se quiser adicioná-la ao catálogo de esquemas do espaço. Isso permite que você visualize o esquema como usuário antes de adicionar a versão sem pré-visualização ao catálogo. A versão prévia permite que você publique sem usar uma versão real. Por exemplo, se você trabalha em uma versão 0.0.1, pode publicar e adicionar uma versão prévia, para que novas atualizações para uma segunda versão possam ser publicadas e adicionadas como 0.0.2.
Para publicar uma versão prévia de um esquema personalizado
Navegue até o link Enable version fornecido para habilitar seu esquema personalizado. Esse link é fornecido ao executar o comando [version number] at:yarn em Etapa 3: visualizar um esquema personalizado.
Depois de criar, desenvolver, visualizar e publicar seu esquema personalizado, você pode publicar e adicionar a versão final do esquema ao catálogo do espaço. Para ter mais informações, consulte Publicação de um esquema personalizado em um espaço e Adicionar um esquema personalizado a um catálogo de esquemas de espaço.
