Publicar um blueprint personalizado em um espaço

Antes de inserir uma planta personalizada no catálogo de plantas do seu espaço, você deve publicá-la no espaço. Você também pode visualizar o blueprint no CodeCatalyst console antes de publicar. Você pode publicar uma versão prévia ou uma versão normal do seu blueprint.

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.

Importante

Para publicar um blueprint personalizado em seu CodeCatalyst espaço, você deve estar conectado com uma conta que tenha a função de administrador do espaço ou usuário avançado no espaço.

Visualizando e publicando uma versão prévia de um blueprint personalizado

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.

Depois de fazer as alterações, reconstrua o pacote do seu blueprint personalizado executando o package.json arquivo e visualize suas alterações.

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

1. Retome seu ambiente de desenvolvimento. Para obter mais informações, consulte Retomar um ambiente de desenvolvimento .

2. Abra um terminal funcional em seu ambiente de desenvolvimento.

3. (Opcional) Em um terminal em funcionamento, instale as dependências necessárias para seu projeto, caso ainda não as tenha instalado. Use o seguinte comando:

   yarn

4. (Opcional) Se você fez alterações no .projenrc.ts arquivo, gere novamente a configuração do seu projeto antes de criar e visualizar seu blueprint. Use o seguinte comando:

   yarn projen

5. Reconstrua e visualize seu blueprint personalizado usando o comando a seguir. Use o seguinte comando:

   yarn blueprint:preview

   Navegue até o See this blueprint at: link fornecido para visualizar seu plano personalizado. 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.

6. (Opcional) Você pode publicar uma versão prévia do seu blueprint personalizado, que pode então ser adicionada ao catálogo de blueprints do seu espaço. Navegue até o Enable version [preview version number] at: link para publicar uma versão prévia em seu espaço.

Você pode emular a criação do projeto sem precisar criar um projeto no CodeCatalyst. Para sintetizar seu projeto, use o seguinte comando:

yarn blueprint:synth

Um blueprint é gerado na synth/synth.[options-name]/proposed-bundle/ pasta. Para ter mais informações, consulte Síntese.

Se você estiver atualizando seu blueprint personalizado, use o comando a seguir para ressintetizar seu projeto:

yarn blueprint:resynth

Um blueprint é gerado na synth/synth.[options-name]/proposed-bundle/ pasta. Para ter mais informações, consulte Ressíntese.

Depois de publicar sua versão prévia, você pode adicionar o blueprint para que os membros do espaço possam usá-lo para criar novos projetos ou adicionar projetos existentes. Para ter mais informações, consulte Adicionar um blueprint personalizado a um catálogo de blueprints espaciais.

Visualizando e publicando uma versão normal de um blueprint personalizado

Depois de terminar de desenvolver e visualizar seu blueprint personalizado, você poderá visualizar e publicar a nova versão que deseja adicionar ao catálogo de blueprints do seu espaço. O fluxo de trabalho de lançamento gerado ao criar um projeto publica automaticamente as alterações que são enviadas por push. Se você desativou a geração do fluxo de trabalho ao criar o blueprint, seu blueprint não será automaticamente disponibilizado para ser adicionado ao catálogo de blueprints do seu espaço. Você ainda pode publicar seu blueprint personalizado em seu espaço depois de executar um yarn comando.

Para visualizar e publicar um blueprint personalizado

1. Retome seu ambiente de desenvolvimento. Para obter mais informações, consulte Retomar um ambiente de desenvolvimento .

2. Abra um terminal funcional em seu ambiente de desenvolvimento.

3. • Se você optou por não gerar o fluxo de trabalho de lançamento ao criar seu blueprint, use o seguinte comando:

     yarn blueprint:release

     Você ainda pode navegar até o See this blueprint at: link fornecido para ver seu plano personalizado.

     Publique a versão atualizada do seu blueprint personalizado, que pode então ser adicionado ao catálogo de blueprints do seu espaço. Navegue até o Enable version [release version number] at: link para publicar a versão mais recente em seu espaço.

   • Se você optou por um fluxo de trabalho de lançamento ao criar seu blueprint, a versão mais recente do blueprint será publicada automaticamente quando as alterações forem enviadas. Use os seguintes comandos:

     git add .

     git commit -m "commit message"

     git push

Depois de publicar sua versão normal, você pode adicionar o blueprint para que os membros do espaço possam usá-lo para criar novos projetos ou adicionar projetos existentes. Para ter mais informações, consulte Adicionar um blueprint personalizado a um catálogo de blueprints espaciais.

Publicar e adicionar um blueprint personalizado em espaços e projetos específicos

Por padrão, os blueprint:release comandos blueprint:preview e são publicados no CodeCatalyst espaço em que você criou o blueprint. Se você tiver vários espaços corporativos, também poderá visualizar e publicar o mesmo esquema nesses espaços. Você também pode adicionar um blueprint a um projeto existente de outro espaço.

Para publicar ou adicionar um blueprint personalizado em um espaço especificado

1. Retome seu ambiente de desenvolvimento. Para ter mais informações, consulte Retomar um ambiente de desenvolvimento .

2. Abra um terminal funcional em seu ambiente de desenvolvimento.

3. (Opcional) Instale as dependências necessárias para seu projeto, caso ainda não as tenha instalado. Use o seguinte comando:

   yarn

4. Use a --space tag para publicar uma versão prévia ou normal em um espaço especificado. Por exemplo: .

   • yarn blueprint:preview --space my-awesome-space # publishes under a "preview" version tag to 'my-awesome-space'

     Resultado do exemplo:

     Enable version 0.0.1-preview.0 at: https://codecatalyst.aws/spaces/my-awesome-space/blueprints
     Blueprint applied to [NEW]: https://codecatalyst.aws/spaces/my-awesome-space/blueprints/%40amazon-codecatalyst%2Fmyspace.my-blueprint/publishers/1524817d-a69b-4abe-89a0-0e4a9a6c53b2/versions/0.0.1-preview.0/projects/create

   • yarn blueprint:release --space my-awesome-space # publishes normal version to 'my-awesome-space'

     Resultado do exemplo:

     Enable version 0.0.1 at: https://codecatalyst.aws/spaces/my-awesome-space/blueprints
     Blueprint applied to [NEW]: https://codecatalyst.aws/spaces/my-awesome-space/blueprints/%40amazon-codecatalyst%2Fmyspace.my-blueprint/publishers/1524817d-a69b-4abe-89a0-0e4a9a6c53b2/versions/0.0.1/projects/create

   Use o --project para adicionar uma versão prévia de um blueprint personalizado a um projeto existente em um espaço especificado. Por exemplo: .

   yarn blueprint:preview --space my-awesome-space --project my-project # previews blueprint application to an existing project

   Resultado do exemplo:

   Enable version 0.0.1-preview.1 at: https://codecatalyst.aws/spaces/my-awesome-space/blueprints
   Blueprint applied to [my-project]: https://codecatalyst.aws/spaces/my-awesome-space/projects/my-project/blueprints/%40amazon-codecatalyst%2FmySpace.my-blueprint/publishers/1524817d-a69b-4abe-89a0-0e4a9a6c53b2/versions/0.0.1-preview.1/add