Skip to main content

Como criar um codespace com base em um modelo

Se você estiver iniciando um novo projeto, poderá criar um codespace com base em um modelo em branco ou escolher um modelo projetado especificamente para o tipo de trabalho que deseja realizar.

Sobre os modelos do GitHub Codespaces

Se você estiver iniciando um novo projeto, poderá começar o trabalho de desenvolvimento rapidamente criando um codespace com base em um modelo. Você poderá trabalhar no projeto em um ambiente de desenvolvimento baseado em nuvem, salvar os arquivos na nuvem e publicar o trabalho em um novo repositório remoto que poderá ser compartilhado com outras pessoas ou clonado no computador local.

Observação: os codespaces criados com base em um modelo, não em um repositório, são sempre cobrados na conta pessoal. Para obter mais informações, confira "Sobre a cobrança do GitHub Codespaces".

Você pode começar com um modelo em branco, escolher entre os modelos mantidos pelo GitHub para tecnologias populares, como React ou Jupyter Notebook, ou iniciar um codespace usando qualquer repositório de modelos no GitHub. Com um modelo em branco, você começará com um diretório vazio, com acesso a recursos de computação baseados em nuvem e as ferramentas, as linguagens e os ambientes de runtime que vêm pré-instalados com a imagem padrão do codespace. Com outros modelos, você obterá arquivos iniciais para a tecnologia com a qual está trabalhando, além de, normalmente, alguns arquivos extras, como um arquivo README, um arquivo .gitignore e arquivos de configuração de contêiner de desenvolvimento que contenham alguma configuração de ambiente personalizada. Para obter mais informações sobre os contêineres de desenvolvimento e a imagem padrão, confira "Introdução aos contêineres de desenvolvimento".

Por exemplo, se você criar um codespace com base em um modelo React do GitHub, acessará um workspace contendo arquivos de modelo para um aplicativo simples, como index.js, app.js e package.json. Logo após a abertura do codespace, um servidor de desenvolvimento será iniciado automaticamente e você poderá ver o aplicativo em execução em uma guia de navegador simples no cliente Web do VS Code.

Captura de tela do modelo React em execução em um codespace

Os arquivos e a configuração incluídos nos modelos são definidos em repositórios de modelo. O repositório de modelos é clonado no codespace quando você cria o codespace. Depois disso, o link será cortado e o codespace não será vinculado a um repositório remoto até que você o publique em um.

Dica: para ajudar as pessoas a começar a usar a estrutura, a biblioteca ou outro projeto, você pode definir um repositório de modelos a ser usado com os GitHub Codespaces. Para obter mais informações, confira "Como configurar o repositório de modelos dos GitHub Codespaces".

Como criar um codespace com base em um modelo do GitHub

Os modelos mantidos pelo GitHub, incluindo o modelo em branco, estão disponíveis na página "Seus codespaces".

  1. Navegue até a página "Seus codespaces" em github.com/codespaces. 1. Para ver a lista completa de modelos, em "Explorar modelos de início rápido", clique em Ver tudo.

    Captura de tela da seção "Explorar modelos de início rápido", com "Ver tudo" realçado

  2. Para ver o repositório de modelos que contém os arquivos de um modelo, você pode clicar no nome do modelo.

    Captura de tela da seção "Explorar modelos de início rápido", com "React" realçado

  3. No modelo que você deseja iniciar, clique em Usar este modelo.

    Captura de tela dos modelos de início rápido, com o botão "Usar este modelo" realçado no modelo React

Quando você cria um codespace a partir de um modelo, ele sempre é aberto no cliente Web Visual Studio Code. Você pode reabrir um codespace existente em qualquer editor compatível. Para saber mais, confira "Como abrir um codespace existente".

Como criar um codespace com base em um repositório de modelos

Você pode criar um codespace com base em qualquer repositório de modelos e publicar o trabalho em um novo repositório quando estiver pronto. Para obter mais informações sobre os repositórios de modelos, confira "Como criar um repositório de modelos".

  1. No GitHub.com, navegue até a página principal do repositório. 1. Acima da lista de arquivos, clique em Usar este modelo e selecione Abrir em um codespace.

    Usar este botão de modelo

    Observação: se você é um mantenedor do repositório de modelos e quer fazer commit de alterações no próprio repositório de modelos, crie um codespace usando o menu suspenso Código. Para obter mais informações, confira "Como criar um codespace para um repositório".

Quando você cria um codespace a partir de um modelo, ele sempre é aberto no cliente Web Visual Studio Code. Você pode reabrir um codespace existente em qualquer editor compatível. Para saber mais, confira "Como abrir um codespace existente".

Como publicar em um repositório no GitHub

Quando você trabalha em um codespace criado com base em um modelo, seu trabalho é salvo em uma máquina virtual na nuvem, mas não é armazenado em um repositório no GitHub.

É possível salvar seus arquivos, fechar e parar o codespace e voltar mais tarde. Normalmente, o Git vem pré-instalado e o diretório de trabalho é inicializado automaticamente como um repositório Git, a menos que você tenha começado com o modelo em branco do GitHub. Isso significa que é possível usar o Git imediatamente para o controle do código-fonte local, como adicionar e confirmar arquivos.

No entanto, se você excluir um codespace não publicado ou ele for excluído automaticamente por não ser usado durante o período de retenção, seu trabalho também será excluído. Para manter seu trabalho e permitir que outras pessoas trabalhem no projeto, publique o codespace em um repositório no GitHub.

Como publicar do VS Code

Se você estiver trabalhando em um codespace, poderá publicá-lo no cliente Web ou no aplicativo da área de trabalho do VS Code.

  1. Na Barra de Atividades, clique na exibição Controle do Código-Fonte. Exibição Controle do Código-Fonte

  2. Para preparar as alterações, clique em + ao lado do arquivo que você alterou ou ao lado de Alterações se tiver alterado vários arquivos e quiser preparar todos eles.

    Barra lateral do controle do código-fonte com o botão de preparo realçado

    Observação: se você começar com o modelo em branco do GitHub, não verá uma lista de alterações, a menos que já tenha inicializado o diretório como um repositório Git. Para publicar codespaces criados por meio do modelo em branco, clique em Publicar no GitHub na exibição Controle do Código-Fonte e pule para a etapa 5.

  3. Para fazer commit das alterações preparadas, digite uma mensagem de commit descrevendo a alteração que você fez e clique em Fazer commit.

    Barra lateral do controle do código-fonte com uma mensagem de commit

  4. Clique em Publicar Branch.

    Captura de tela do botão "Publicar Branch" no VS Code

  5. Na lista suspensa "Nome do Repositório", digite um nome para o novo repositório e selecione Publicar no repositório privado do GitHub ou Publicar no repositório público do GitHub .

    Captura de tela da lista suspensa "Nome do Repositório" no VS Code

    O proprietário do novo repositório será a conta do GitHub com a qual você criou o codespace.

  6. Opcionalmente, no pop-up exibido no canto inferior direito do editor, clique em Abrir no GitHub para exibir o novo repositório no GitHub.com.

    Captura de tela do pop-up "Abrir no GitHub" no VS Code

Quando um codespace é publicado, você tem acesso a uma gama maior de opções para personalizar a experiência dos GitHub Codespaces. Por exemplo, você pode:

Como publicar do GitHub.com

Você pode publicar um codespace não publicado usando a página "Seus codespaces" no GitHub.com. Isso é útil para publicar um codespace que não está aberto no navegador no momento. Se você fizer isso, o trabalho será preservado em um repositório, mas não haverá um link entre o codespace existente e o novo repositório. No entanto, você pode navegar até o novo repositório e criar um codespace a partir daí, e esse codespace será conectado ao repositório.

  1. Navegue até a página "Seus codespaces" em github.com/codespaces.

  2. Ao lado do codespace não publicado, clique nas reticências ( ... ) e selecione Publicar em um novo repositório.

    Captura de tela do botão "Publicar em um novo repositório"

  3. Escolha um nome para o novo repositório, defina-o como Público ou Privado e clique em Criar repositório.

    Captura de tela do menu suspenso "Publicar em um novo repositório"

  4. Opcionalmente, para ver o novo repositório, clique em Ver repositório.

Leitura adicional