Skip to main content

Como criar um codespace para um repositório

Você pode criar um codespace para uma branch em um repositório para fazer o desenvolvimento on-line.

Sobre como criar um codespace para um repositório

Você pode criar um codespace em GitHub.com, em Visual Studio Code, ou usando GitHub CLI. Use as guias neste artigo para ver instruções de cada uma dessas maneiras de criar um codespace.

Ao iniciar um novo projeto, você pode criar um codespace com base em um modelo e publicá-lo mais tarde em um repositório no GitHub Enterprise Cloud. Para saber mais, confira "Como criar um codespace com base em um modelo".

Observação: se você usar um IDE do JetBrains, poderá usar GitHub CLI para criar um codespace. Depois, você poderá usar o aplicativo JetBrains Gateway para abrir o codespace em um IDE do JetBrains. Para obter mais informações, confira "Como usar codespaces no IDE do JetBrains".

Você pode usar os GitHub Codespaces na sua conta pessoal do GitHub.com, com a cota de uso gratuito incluída por mês para contas nos planos Gratuito e Pro. Você pode continuar usando o GitHub Codespaces além do uso mensal incluído de armazenamento e computação fornecendo detalhes de pagamento e definindo um limite de gastos. Para obter mais informações, confira "Sobre a cobrança do GitHub Codespaces".

As organizações podem permitir que membros e colaboradores externos criem e usem codespaces às custas da organização. Para obter mais informações, confira "Como habilitar GitHub Codespaces para sua organização".

Cada espaço de código que criar só está disponível para você. Ninguém mais pode trabalhar no seu espaço de código.

Se você criar um codespace com base em um repositório, o codespace será associado a um branch específico, que não poderá estar vazio. Você pode criar mais de um código de espaço por repositório ou até mesmo por branch.

Você poderá ver todos os codespaces disponíveis que criou em github.com/codespaces.

O processo de criação do codespace

Ao criar um codespace, várias etapas acontecem para criar e conectar você ao seu ambiente de desenvolvimento:

  • Etapa 1: A VM e o armazenamento são atribuídos ao seu codespace.
  • Etapa 2: O contêiner é criado e seu repositório é clonado.
  • Passo 3: Você pode conectar-se ao codespace.
  • Etapa 4: O codespace continua com a configuração pós-criação.

Para obter mais informações sobre o que acontece quando você cria um codespace, confira "Aprofundamento".

Para obter mais informações sobre o ciclo de vida de um codespace, confira "Ciclo de vida dos codespaces".

Caso deseje usar ganchos do Git para seu codespace, configure os ganchos usando os scripts de ciclo de vida de devcontainer.json, como postCreateCommand, durante a etapa 4. Como o contêiner de codespace é criado depois que o repositório é clonado, qualquer diretório de modelo do Git configurado na imagem de contêiner não se aplicará ao seu codespace. Os Hooks devem ser instalados depois que o codespace for criado. Para obter mais informações sobre como usar o postCreateCommand, consulte a referência do devcontainer.json na documentação do VS Code.

Você pode editar código, depurar e usar comandos do Git ao mesmo tempo que faz o desenvolvimento em um codespace com VS Code. Para obter mais informações, confira a documentação do VS Code.

Para acelerar a criação de codespaces, os administradores de repositório podem habilitar pré-builds do GitHub Codespaces em um repositório. Para obter mais informações, confira "Sobre as predefinições do GitHub Codespaces".

Como criar um codespace para um repositório

  1. No GitHub.com, navegue até a página principal do repositório.

  2. No nome do repositório, use o menu suspenso "Branch", e selecione o branch para o qual você deseja criar um codespace.

    Menu suspenso Branch

  3. Clique no botão Código e clique na guia Codespaces.

    Botão de codespace novo

    Se os codespaces desse repositório forem faturáveis para uma organização, uma mensagem será exibida abaixo do botão Criar codespace no BRANCH informando quem pagará pelo codespace.

  4. Crie seu codespace, usando as opções padrão ou depois de configurar opções avançadas:

    • Usar as opções padrão

      Para criar um codespace usando as opções padrão, clique no sinal de adição (). Como alternativa, se no momento você não tiver nenhum codespace para esse repositório, clique em Criar codespace no BRANCH.

    • Configurar opções

      Para configurar opções avançadas para seu codespace, como um tipo de computador diferente ou um arquivo específico devcontainer.json:

      1. Clique nas reticências ( ... ) no canto superior direito da guia Codespaces e selecione Novo com opções.

        Exibir o tipo de computador padrão

      2. Na página de opções do codespace, escolha as opções da sua preferência nos menus suspensos.

        A página de opções do codespace

        Observações

      3. Clique em Criar codespace.

Depois de conectar a conta no GitHub.com à extensão GitHub Codespaces, você poderá criar um codespace. Para obter mais informações sobre a extensão GitHub Codespaces, veja o VS Code Marketplace.

  1. Em VS Code, na barra lateral esquerda, clique no ícone do Gerenciador Remoto.

    O ícone do Remote Explorer no Visual Studio Code

    Observação: se o Gerenciador Remoto não for exibido na Barra de Atividades:

    1. Abra a paleta de comandos. Por exemplo, pressionando Shift+Command+P (no Mac) / Ctrl+Shift+P (no Windows/Linux).
    2. Digite: codespaces.
    3. Clique em Codespaces: detalhes.
  2. Clique no ícone de Adição: .

    A opção Criar codespace nos GitHub Codespaces

  3. Digite o nome do repositório no qual você deseja desenvolver e selecione-o.

    Como procurar um repositório para criar um codespace

    Se o repositório escolhido pertencer a uma organização e a organização tiver configurado os codespaces desse repositório como faturáveis para a organização ou empresa matriz, uma mensagem será exibida nos próximos prompts informando quem pagará pelo codespace.

  4. Clique no branch que você deseja desenvolver.

    Como procurar um branch para criar um codespace

  5. Se solicitado a escolher um arquivo de configuração de contêiner de desenvolvimento, escolha um arquivo na lista.

    Como escolher um arquivo de configuração de contêiner de desenvolvimento para GitHub Codespaces

  6. Clique no tipo de computador que você quer usar.

    Tipos de instância para um novo codespace

    Observação: Sua escolha de tipos de computador disponíveis pode ser limitada por vários fatores. Esses fatores podem incluir uma política configurada para a organização ou uma especificação mínima de tipo de computador para o repositório. Para obter mais informações, confira "Como restringir o acesso aos tipos de computadores" e "Como definir uma especificação mínima para computadores de codespace".

Para saber mais sobre a GitHub CLI, confira "Sobre a GitHub CLI".

Para criar um codespace, use o subcomando gh codespace create.

gh codespace create 

Será solicitado que você escolha um repositório. Se os codespaces desse repositório forem faturáveis para uma organização ou para a empresa pai, uma mensagem será exibida abaixo informando quem pagará pelo codespace. Depois será solicitado que você escolha um branch, um arquivo de configuração do contêiner de desenvolvimento (se mais de um estiver disponível) e um tipo de computador (se mais de um estiver disponível).

Como alternativa, você pode usar sinalizadores para especificar algumas ou todas as opções:

gh codespace create -r OWNER/REPO -b BRANCH --devcontainer-path PATH -m MACHINE-TYPE

Neste exemplo, substitua owner/repo pelo identificador do repositório. Substitua branch pelo nome do branch ou pelo hash do SHA completo do commit do qual você deseja fazer check-out inicialmente no codespace. Se você usar o sinalizador -r sem o sinalizador b, o codespace será criado com base no branch padrão.

Substitua path pelo caminho para o arquivo de configuração do contêiner de desenvolvimento que você deseja usar para o novo codespace. Se você omitir esse sinalizador e mais de um tipo de máquina estiver disponível, deverá escolher uma na lista. Para saber mais sobre contêineres de desenvolvimento, confira "Introdução aos contêineres de desenvolvimento".

Substitua machine-type por um identificador válido para um tipo de computador disponível. Os identificadores são cadeias de caracteres como: basicLinux32gb e standardLinux32gb. O tipo de máquina que está disponível depende do repositório, da sua conta pessoal e da sua localização. Se você digitar um tipo de máquina inválido ou indisponível, os tipos disponíveis serão mostrados na mensagem de erro. Se você omitir este sinalizador e mais de um tipo de máquina estiver disponível, será solicitado que você escolha uma na lista.

Para obter detalhes completos das opções para esse comando, confira o manual do GitHub CLI.

Leitura adicional