Skip to main content
Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais atualizadas, acesse a documentação em inglês.

Abrir arquivos automaticamente nos codespaces de um repositório

Você pode definir arquivos específicos a serem abertos automaticamente sempre que alguém criar um codespace para seu repositório e abrir o codespace no cliente Web Visual Studio Code.

Quem pode usar esse recurso

People with write permissions to a repository can create or edit the codespace configuration.

Visão geral

Se houver um arquivo específico que seja útil para as pessoas verem quando criarem um codespace para seu repositório, você poderá definir esse arquivo para ser aberto automaticamente no cliente Web do VS Code. Configure isso no arquivo de configuração do contêiner de desenvolvimento para o repositório.

O arquivo ou os arquivos especificados só são abertos na primeira vez em que um codespace é aberto no cliente Web. Se a pessoa fechar os arquivos especificados, esses arquivos não serão reabertos automaticamente na próxima vez que essa pessoa abrir ou reiniciar o codespace.

Observação: essa automação só se aplica ao cliente Web do VS Code, não ao aplicativo de área de trabalho VS Code ou a outros editores com suporte.

Configurar arquivos para serem abertos automaticamente

  1. Os GitHub Codespaces do repositório podem ser configurados em um arquivo devcontainer.json. Se o repositório ainda não contiver um arquivo devcontainer.json, adicione um agora. Confira "Adicionando uma configuração de contêiner de desenvolvimento ao repositório".

  2. Edite o arquivo devcontainer.json, adicionando uma propriedade customizations.codespaces.openFiles. A propriedade customizations reside no nível superior do arquivo, dentro do objeto JSON delimitador. Por exemplo:

    JSON
    "customizations": {
      "codespaces": {
        "openFiles": [
          "README.md",
          "scripts/tsconfig.json",
          "docs/main/CODING_STANDARDS.md"
        ]
      }
    }

    O valor da propriedade openFiles é uma matriz de um ou mais arquivos do seu repositório. Os caminhos são relativos à raiz do repositório (não há suporte para caminhos absolutos). Os arquivos são abertos no cliente Web na ordem especificada, com o primeiro arquivo da matriz exibido no editor.

  3. Salve o arquivo e faça commit as alterações no branch necessário do repositório.

Leitura adicional