Introdução aos esquemas personalizados

Durante o processo de criação de um blueprint, você pode configurar o blueprint e gerar uma prévia dos recursos do projeto. Cada blueprint personalizado é gerenciado por um CodeCatalyst projeto, que contém um fluxo de trabalho por padrão para publicação no catálogo de blueprints do espaço.

Ao configurar os detalhes do seu blueprint personalizado, você também pode optar por armazenar o código-fonte do seu blueprint em um repositório de terceiros, onde você ainda pode gerenciar o blueprint personalizado e utilizar os recursos de gerenciamento do ciclo de vida para manter os projetos do seu espaço sincronizados quando o blueprint personalizado é modificado. Para obter mais informações, consulte Adicione funcionalidade a projetos com extensões no CodeCatalyst e Trabalhando com o gerenciamento do ciclo de vida como autor do plano.

Se você já tem um repositório de origem com padronização e melhores práticas em vigor, você pode optar por converter esse repositório de origem em um blueprint personalizado. Para ter mais informações, consulte Conversão de repositórios de origem em esquemas personalizados.

Pré-requisitos

Antes de criar um blueprint personalizado, considere os seguintes requisitos:

• Seu CodeCatalyst espaço deve ser do nível Enterprise. Para obter mais informações, consulte Gerenciando o faturamento no Amazon CodeCatalyst Administrator Guide.

• Você precisa ter a função de administrador do Space ou de usuário avançado para criar blueprints personalizados. Para ter mais informações, consulte Concedendo acesso com funções de usuário.

Etapa 1: criar um blueprint personalizado no CodeCatalyst

Quando você cria um blueprint personalizado a partir das configurações do seu espaço, um repositório é criado para você. O repositório inclui todos os recursos necessários para desenvolver seu blueprint antes de publicá-lo no catálogo de blueprints do espaço.

Para criar um blueprint personalizado

1. Abra o CodeCatalyst console em https://codecatalyst.aws/.

2. No CodeCatalyst console, navegue até o espaço em que você deseja criar um blueprint personalizado.

3. No painel do espaço, escolha a guia Configurações e, em seguida, escolha Blueprints.

4. Escolha Criar blueprint.

5. Em Nomeie seu blueprint, 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.

6. (Opcional) Por padrão, o código-fonte criado pelo blueprint é armazenado em um CodeCatalyst repositório. Como alternativa, você pode optar por armazenar o código-fonte do blueprint em um repositório de terceiros. Para ter mais informações, consulte Adicione funcionalidade a projetos com extensões no CodeCatalyst.

   Faça o seguinte, dependendo do provedor de repositório terceirizado que você deseja usar:

   • GitHub repositórios: Conecte uma GitHub conta.

     Escolha o menu suspenso Avançado, escolha GitHub como provedor do repositório e escolha a GitHub conta na qual você deseja armazenar o código-fonte criado pelo blueprint.

     nota

     Se você estiver usando uma conexão com uma GitHub conta, deverá criar uma conexão pessoal para estabelecer o mapeamento de identidade entre sua CodeCatalyst identidade e sua GitHub identidade. Para obter mais informações, consulte Conexões pessoais e Acessando GitHub recursos com conexões pessoais.

   • Repositórios do Bitbucket: conecte um espaço de trabalho do Bitbucket.

     Escolha o menu suspenso Avançado, escolha Bitbucket como provedor de repositório e, em seguida, escolha o espaço de trabalho do Bitbucket em que você deseja armazenar o código-fonte criado pelo blueprint.

   • GitLab repositórios: Conecte um GitLab usuário.

     Escolha o menu suspenso Avançado, escolha GitLab como provedor do repositório e, em seguida, escolha o GitLab usuário no qual você deseja armazenar o código-fonte criado pelo blueprint.

7. Em Detalhes do Blueprint, faça o seguinte:

   1. No campo de entrada de texto do nome de exibição do Blueprint, insira um nome que aparecerá no catálogo de blueprints do seu espaço.

   2. No campo de entrada de texto Descrição, insira uma descrição para seu blueprint personalizado.

   3. No campo de entrada de texto Nome do autor, insira um nome de autor para seu blueprint personalizado.

   4. (Opcional) Escolha as configurações avançadas.

      1. Escolha + Adicionar para adicionar tags que são adicionadas ao package.json arquivo.

      2. Escolha o menu suspenso Licença e, em seguida, escolha uma licença para seu blueprint personalizado.

      3. No campo de entrada de texto do nome do pacote do Blueprint, insira um nome para identificar seu pacote do blueprint.

      4. Por padrão, um fluxo de trabalho de lançamento é gerado usando um blueprint de publicação em seu projeto chamado Blueprint Builder. O fluxo de trabalho publica a versão mais recente do blueprint 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 Liberar fluxo de trabalho.

8. (Opcional) Um projeto de planta vem com código predefinido para apoiar a publicação da planta no catálogo de plantas 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, escolha Exibir código ou Exibir fluxo de trabalho em Gerar visualização do blueprint.

9. Escolha Criar blueprint.

Se você não desativou a geração do fluxo de trabalho para seu blueprint personalizado, o fluxo de trabalho começa a ser executado automaticamente quando seu blueprint é criado. Quando a execução do fluxo de trabalho estiver concluída, seu blueprint personalizado estará disponível para ser adicionado ao catálogo de blueprints do seu 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 blueprint seja publicada automaticamente no seu espaço. Para obter mais informações, consulte Definindo permissões de publicação para um blueprint personalizado e Executar um fluxo de trabalho.

Como o fluxo de trabalho de publicação chamado blueprint-release é criado usando um blueprint, o blueprint pode ser encontrado como um blueprint aplicado em seu projeto. Para obter mais informações, consulte Adicionar um blueprint em um projeto para integrar recursos e Desassociar um blueprint de um projeto para interromper as atualizações.

Etapa 2: Desenvolver um plano personalizado com componentes

Um assistente de blueprint é gerado quando você cria um blueprint personalizado e pode ser modificado com componentes ao desenvolver o blueprint personalizado. Você pode atualizar os src/defaults.json arquivos src/blueprints.js e para modificar o assistente.

Importante

Se você quiser usar pacotes de blueprint de fontes externas, considere os riscos que podem vir com esses pacotes. Você é responsável pelos blueprints personalizados que adiciona ao seu espaço e pelo código que eles geram.

Crie um ambiente de desenvolvimento em seu CodeCatalyst projeto com um ambiente de desenvolvimento integrado (IDE) compatível antes de configurar seu código de blueprint. É necessário um ambiente de desenvolvimento para trabalhar com as ferramentas e pacotes necessários.

Para criar um ambiente de desenvolvimento

1. No painel de navegação, faça o seguinte:

   1. Escolha Visão geral e, em seguida, navegue até a seção Meus ambientes de desenvolvimento.

   2. Escolha Código e, em seguida, escolha Dev Environments.

   3. Escolha Código, escolha Repositórios de origem e escolha o repositório que você criou ao criar seu blueprint.

2. Escolha Criar ambiente de desenvolvimento.

3. Escolha um IDE compatível no menu suspenso. Consulte Ambientes de desenvolvimento integrados compatíveis para ambientes de desenvolvimento para obter mais informações.

4. Escolha Trabalhar na ramificação existente e, no menu suspenso Ramificação existente, escolha a ramificação do recurso que você criou.

5. (Opcional) No campo Alias - entrada de texto opcional, insira um alias para identificar o ambiente de desenvolvimento.

6. Escolha Criar. Enquanto seu ambiente de desenvolvimento está sendo criado, a coluna de status do ambiente de desenvolvimento exibe Iniciando e a coluna de status exibe Executando quando o ambiente de desenvolvimento foi criado.

Para ter mais informações, consulte Escreva e modifique o código com Dev Environments em CodeCatalyst.

Para desenvolver seu plano personalizado

1. Em um terminal em funcionamento, use o seguinte yarn comando para instalar dependências:

   yarn

   As ferramentas e os pacotes necessários são disponibilizados por meio do CodeCatalyst Dev Environment, incluindo o Yarn. Se você estiver trabalhando em um blueprint personalizado sem um ambiente de desenvolvimento, instale primeiro o Yarn em seu sistema. Para obter mais informações, consulte a documentação de instalação do Yarn.

2. Desenvolva seu plano personalizado para que ele seja configurado de acordo com suas preferências. Você pode modificar o assistente do seu blueprint adicionando componentes. Para obter mais informações, consulte Desenvolvendo um plano personalizado para atender aos requisitos do projeto, Modificando recursos do blueprint com um assistente de front-end e Publicar um blueprint personalizado em um espaço.

Etapa 3: visualizar um blueprint personalizado

Depois de configurar e desenvolver seu blueprint personalizado, você pode visualizar e publicar a versão prévia do seu blueprint em seu espaço. Uma versão prévia permite verificar se o blueprint é o que você deseja antes de ser usado para criar novos projetos ou aplicado a projetos existentes.

Para visualizar um blueprint personalizado

1. Em um terminal em funcionamento, use o seguinte yarn comando:

   yarn blueprint:preview

2. Navegue até o See this blueprint at: link fornecido para visualizar seu plano personalizado.

3. Verifique se a interface do usuário, incluindo o texto, aparece conforme o esperado com base na sua configuração. Se quiser alterar seu blueprint personalizado, você pode editar o blueprint.ts arquivo, ressintetizar o blueprint e depois publicar uma versão prévia novamente. Para ter mais informações, consulte Ressíntese.

(Opcional) Etapa 4: publicar uma versão de pré-visualização personalizada do blueprint

Você pode publicar uma versão prévia do seu blueprint personalizado no seu espaço se quiser adicioná-la ao catálogo de blueprints do seu espaço. Isso permite que você visualize o blueprint 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 0.0.1 versão, pode publicar e adicionar uma versão prévia, para que novas atualizações para uma segunda versão possam ser publicadas e adicionadas como0.0.2.

Para publicar uma versão prévia de um blueprint personalizado

Navegue até o Enable version [version number] at: link fornecido para ativar seu plano personalizado. Esse link é fornecido ao executar o yarn comando emEtapa 3: visualizar um blueprint personalizado.

Depois de criar, desenvolver, visualizar e publicar seu blueprint personalizado, você pode publicar e adicionar a versão final do blueprint ao catálogo de blueprints do seu espaço. Para ter mais informações, consulte Publicar um blueprint personalizado em um espaço e Adicionar um blueprint personalizado a um catálogo de blueprints espaciais.