Publicação de um esquema personalizado em um espaço - Amazon CodeCatalyst
Visualização e publicação de uma versão prévia de um esquema personalizadoVisualização e publicação de uma versão normal de um esquema personalizadoPublicação e adição de um esquema personalizado em espaços e projetos especificados

Publicação de um esquema personalizado em um espaço

Antes de adicionar um esquema personalizado ao catálogo de esquemas do seu espaço, você deve publicá-lo no espaço. Você também pode visualizar o esquema no console do CodeCatalyst antes da publicação. Você pode publicar uma versão prévia ou uma versão normal do seu esquema.

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.

Importante

Para publicar um esquema personalizado no espaço do CodeCatalyst, você deve estar conectado com uma conta que tenha o perfil de Administrador do espaço ou Usuário avançado no espaço.

Visualização e publicação de uma versão prévia de um 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.

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

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

  1. Retome o Ambiente de Desenvolvimento. Para ter mais informações, consulte Retomar um Ambiente de Desenvolvimento .

  2. Abra um terminal funcional no Ambiente de Desenvolvimento.

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

    yarn

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

    yarn projen

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

    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.

  6. (Opcional) Você pode publicar uma versão prévia do esquema personalizado, que pode ser adicionada ao catálogo de esquemas do espaço. Navegue até o link Enable version [preview version number] at: 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. Use o comando a seguir para sintetizar seu projeto:

yarn blueprint:synth

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

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

yarn blueprint:resynth

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

Depois de publicar a versão prévia, você pode adicionar o esquema 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 esquema personalizado a um catálogo de esquemas de espaço.

Visualização e publicação de uma versão normal de um esquema personalizado

Quando terminar de desenvolver e visualizar o esquema personalizado, você poderá visualizar e publicar a nova versão que deseja adicionar ao catálogo de esquemas 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 esquema, seu esquema não será automaticamente disponibilizado para ser adicionado ao catálogo de esquemas do espaço. Você ainda pode publicar o esquema personalizado no espaço depois de executar um comando yarn.

Para visualizar e publicar um esquema personalizado

  1. Retome o Ambiente de Desenvolvimento. Para ter mais informações, consulte Retomar um Ambiente de Desenvolvimento .

  2. Abra um terminal funcional no Ambiente de Desenvolvimento.

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

      yarn blueprint:release

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

      Publique a versão atualizada do esquema personalizado, que pode ser adicionada ao catálogo de esquemas do espaço. Navegue até o link Enable version [release version number] at: 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 esquema, a versão mais recente do esquema 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 a versão normal, você pode adicionar o esquema 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 esquema personalizado a um catálogo de esquemas de espaço.

Publicação e adição de um esquema personalizado em espaços e projetos especificados

Por padrão, os comandos blueprint:preview e blueprint:release são publicados no espaço do CodeCatalyst em que você criou o esquema. 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 esquema a um projeto existente de outro espaço.

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

  1. Retome o Ambiente de Desenvolvimento. Para ter mais informações, consulte Retomar um Ambiente de Desenvolvimento .

  2. Abra um terminal funcional no Ambiente de Desenvolvimento.

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

    yarn

  4. Use a tag --space 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 esquema 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