Sobre a personalização de Codespaces
Ao usar qualquer ambiente de desenvolvimento, a personalização das configurações e ferramentas para suas preferências e fluxos de trabalho é uma etapa importante. O GitHub Codespaces oferece duas maneiras de personalizar codespaces.
- Sincronização de configurações: é possível sincronizar suas configurações do Visual Studio Code entre o aplicativo da área de trabalho e o cliente Web do VS Code.
- Dotfiles – você pode usar um
dotfiles
repositório para especificar scripts, preferências de shell e outras configurações.
A personalização do GitHub Codespaces se aplica a qualquer codespace criado.
Os mantenedores do projeto também podem definir uma configuração-padrão que se aplica a todos os codespaces de um repositório, criados por qualquer pessoa. Para obter mais informações, confira "Introdução aos contêineres de desenvolvimento".
Configurações de sincronização
A sincronização de configurações permite sincronizar configurações, como definições, atalhos de teclado, snippets, extensões e estados da IU em computadores e instâncias do VS Code. Para obter mais informações, confira Sincronização de Configurações na documentação do VS Code.
Quando você habilita a Sincronização de Configurações em uma instância do VS Code, como o aplicativo de área de trabalho VS Code em seu laptop, suas configurações para essa instância são armazenadas na nuvem. Na nuvem, efetua-se pull das configurações para todos os novos codespaces no ponto de criação e elas são sincronizadas continuamente com quaisquer codespaces existentes em que a Sincronização de Configurações esteja habilitada.
Se a Sincronização de Configurações estará habilitada por padrão em um codespace dependerá das configurações existentes e de você abrir o codespace no navegador ou no aplicativo de área de trabalho VS Code.
- Se você abrir um codespace no navegador, a Sincronização de Configurações sempre será desabilitada primeiro. Isso significa que a transferência de configurações só ocorre em uma direção e ao mesmo tempo: GitHub Codespaces puxa as configurações armazenadas na nuvem para o codespace no ponto de criação, mas todas as atualizações feitas nas configurações no codespace não são propagadas para a nuvem, portanto, não são refletidas em nenhum outro codespace. Da mesma forma, todas as atualizações que você fizer em suas configurações em outro lugar não serão refletidas em seu codespace.
- Se você abrir um codespace no aplicativo da área de trabalho do VS Code, a Sincronização de Configurações permanecerá habilitada no codespace se você o tiver habilitado anteriormente para o aplicativo. Todas as atualizações que você fizer nas configurações serão enviadas por push à nuvem, portanto, serão refletidas nos codespaces novos e em qualquer codespace existente que tiver a Sincronização de Configurações habilitada. Se você faz atualizações nas configurações de outras instâncias do VS Code em que a Sincronização de Configurações está habilitada, essas atualizações são refletidas no seu codespace.
Se estiver trabalhando em um codespace que tem a Sincronização de Configurações desabilitada, você poderá habilitar esse recurso para enviar por push para a nuvem as alterações feitas nas configurações ou para efetuar pull das alterações mais recentes nas configurações feitas em outro lugar.
Como Habilitar a Sincronização de Configurações
Nota: Você só deve habilitar a Sincronização de Configurações em codespaces criados por meio de repositórios em que você confia. Para obter mais informações, confira "Segurança nos GitHub Codespaces".
-
Em VS Code, na parte inferior da Barra de Atividades, selecione e clique em Ativar Sincronização de Configurações…
-
Na lista suspensa, selecione quais configurações você deseja sincronizar.
-
Clique em Entrar e Ativar, depois selecione a conta em que deseja que as configurações sejam sincronizadas.
Quando você entrar, a instância do VS Code em que você está trabalhando será atualizada imediatamente para exibir as últimas configurações sincronizadas.
Como desabilitar a Sincronização de Configurações
Você pode desabilitar a Sincronização de Configurações a fim de interromper a sincronização de configurações de/para uma instância do VS Code.
Por padrão, quando você desabilitar a Sincronização de Configurações, novos codespaces continuarão a usar as configurações armazenadas em cache da última vez em que as suas configurações foram enviadas por push para a nuvem. Se os codespaces ainda estiverem sendo criados com as configurações armazenadas em cache e você quiser voltar a usar as configurações padrão do VS Code neles, poderá limpar o cache na nuvem ao desabilitar a Sincronização de Configurações.
-
Se a Sincronização de Configurações estiver desabilitada na sua instância do VS Code, primeiro será necessário habilitá-la. Para obter instruções, confira "Como habilitar a sincronização de configurações".
-
Na parte inferior da Barra de Atividades, selecione e clique em Ativar Sincronização de Configurações.
-
Na lista suspensa, clique em Desativar Sincronização de Configurações.
-
Para limpar as configurações armazenadas em cache, no diálogo, selecione Desativar sincronização em todos os dispositivos e limpar os dados da nuvem.
-
Clique em Desativar.
Dotfiles
Os Dotfiles são arquivos e pastas de sistemas de tipo Unix, que começam com .
e controlam a configuração de aplicativos e shells no seu sistema. Você pode armazenar e gerenciar seus dotfiles em um repositório no GitHub. Para orientação e tutoriais sobre o que incluir no repositório dotfile, confira GitHub faz dotfiles.
O seu repositório dotfiles pode incluir os alias e preferências do seu shell, quaisquer ferramentas que você deseja instalar ou qualquer outra personalização de codespace que desejar fazer.
É possível configurar o GitHub Codespaces para usar dotfiles de qualquer repositório que você tenha, selecionando-o nas suas Configurações pessoais do GitHub Codespaces.
Ao criar um novo codespace, o GitHub clona seu repositório dotfile selecionado para o ambiente do codespace e procura um dos seguintes arquivos para configurar o ambiente.
- install.sh
- install
- bootstrap.sh
- bootstrap
- script/bootstrap
- setup.sh
- setup
- script/setup
Se nenhum desses arquivos for encontrado, todos os arquivos ou pastas no repositório de dotfiles selecionados que começam com .
têm um link simbólico para o ~
do codespace ou $HOME
.
Quaisquer alterações nos seus dotfiles selecionados serão aplicadas apenas a cada novo codespace e não afetarão nenhum codespace existente.
Observação: atualmente, o Codespaces não é compatível com a personalização das configurações com escopo do usuário para o VS Code com o repositório dotfiles
. Você pode definir as configurações padrão do Workspace e Remoto [Codespaces] para um projeto específico no repositório do projeto. Para obter mais informações, confira "Introdução aos contêineres de desenvolvimento".
Habilitando o repositório de dotfiles para Codespaces
É possível usar o repositório de dotfiles selecionado para personalizar o ambiente do GitHub Codespaces. Depois de escolher o seu repositório de dotfiles, você poderá adicionar seus scripts, preferências e configurações. Em seguida, você deve habilitar os dotfiles na sua página pessoal de configurações do GitHub Codespaces.
Aviso: Dotfiles têm a capacidade de executar scripts arbitrários, que podem conter codespace inesperado ou malicioso. Antes de instalar o repositório de um dotfiles, recomendamos verificar os scripts para garantir que eles não executam nenhuma ação inesperada.
-
No canto superior direito de qualquer página, clique na foto do seu perfil e em Configurações.
1. Na seção "Código, planejamento e automação" da barra lateral, clique em Codespaces.
-
Em "Dotfiles", selecione Instalar dotfiles automaticamente para que o GitHub Codespaces instale automaticamente seus dotfiles em cada novo codespace que for criado.
-
Escolha o repositório no qual você deseja instalar dotfiles.
Você pode adicionar mais script, preferências e arquivos de configuração ao repositório de dotfiles ou editar arquivos existentes sempre que quiser. As alterações nas configurações só serão selecionadas por novos codespaces.
Se o codespace não conseguir selecionar as definições de configuração dos dotfiles, confira "Solucionar problemas das opções de personalização no GitHub Codespaces".
Outras configurações disponíveis
Também é possível personalizar o GitHub Codespaces usando opções adicionais em suas configurações pessoais:
- Para habilitar a verificação de GPG, confira "Como gerenciar a verificação de GPG do GitHub Codespaces".
- Para definir seu editor, confira "Como configurar o editor padrão do GitHub Codespaces".
- Para definir o tempo máximo de inutilização de um codespace antes de sua interrupção automática, confira "Configurar o período de tempo limite para o GitHub Codespaces".
- Para definir o período pelo qual seus codespaces não utilizados são retidos, confira "Como configurar a exclusão automática dos seus codespaces".
- Para definir sua região padrão, confira "Como configurar sua região padrão do GitHub Codespaces".