À propos de la personnalisation de Codespaces
Lors de l’utilisation d’un environnement de développement, la personnalisation des paramètres et outils selon vos préférences et workflows constitue une étape importante. GitHub Codespaces vous permet de personnaliser vos codespaces de deux façons principales.
- Synchronisation des paramètres : vous pouvez synchroniser vos paramètres Visual Studio Code entre l’application de bureau et le client web VS Code.
- Dotfiles : vous pouvez utiliser un référentiel
dotfilespour spécifier des scripts, des préférences d’interpréteur de commandes et d’autres configurations.
La personnalisation GitHub Codespaces s’applique à tout codespace que vous créez.
Les personnes en charge de la maintenance du projet peuvent également définir une configuration par défaut qui s’applique à chaque codespace d’un référentiel, créé par n’importe qui. Pour plus d’informations, consultez « Présentation des conteneurs de développement ».
Synchronisation des paramètres
La synchronisation des paramètres vous permet de synchroniser des configurations telles que les paramètres, les raccourcis clavier, les extraits de code, les extensions et l’état de l’interface utilisateur sur les machines et les instances de VS Code. Pour plus d’informations, consultez Synchronisation des paramètres dans la documentation de VS Code.
Lorsque vous activez la synchronisation des paramètres dans une instance de VS Code, comme l’application de bureau VS Code sur votre ordinateur portable, les paramètres pour cette instance sont stockés dans le cloud. À partir du cloud, les paramètres sont tirés (pull) vers tous les nouveaux codespaces au point de création, et sont synchronisés en continu avec tous les codespaces existants où la synchronisation des paramètres est activée.
La synchronisation des paramètres peut être activée par défaut dans un codespace. Cela dépend de vos paramètres existants, et si vous avez ouvert le codespace dans le navigateur ou dans l’application de bureau VS Code.
- Si vous ouvrez un codespace dans le navigateur, la synchronisation des paramètres est toujours désactivée au début. Cela signifie que le transfert des paramètres s’effectue dans une seule direction et à un moment donné : GitHub Codespaces tire les paramètres stockés dans le cloud vers le codespace au moment de la création. Toutefois, les mises à jour que vous apportez aux paramètres dans le codespace sont ne sont pas propagées au cloud, et ne sont donc pas reflétées dans les autres codespaces. De même, les mises à jour que vous apportez à vos paramètres ailleurs ne sont pas reflétées dans votre codespace.
- Si vous ouvrez un codespace dans l’application de bureau VS Code, la synchronisation des paramètres reste activée dans le codespace, si vous l’avez déjà activée pour l’application. Toutes les mises à jour que vous apportez à vos paramètres sont poussées vers le cloud. Elles sont donc reflétées dans les nouveaux codespaces et les codespaces existants dans lesquels la synchronisation des paramètres est activée. Si vous apportez des mises à jour à vos paramètres dans d’autres instances de VS Code où la synchronisation des paramètres est activée, ces mises à jour sont reflétées dans votre codespace.
Si vous utilisez un codespace où la synchronisation des paramètres est désactivée, vous pouvez activer la synchronisation des paramètres pour pousser les changements que vous avez apportés à vos paramètres vers le cloud, ou tirer les derniers changements que vous avez apportés à vos paramètres ailleurs.
Activation de la synchronisation des paramètres
Remarque : Vous devez uniquement activer la synchronisation des paramètres dans les codespaces créés à partir de dépôts dans lesquels vous avez confiance. Pour plus d’informations, consultez « Sécurité dans GitHub Codespaces ».
-
Dans VS Code, au bas de la barre d’activités, sélectionnez , puis cliquez sur Activer la synchronisation des paramètres...
-
Dans la liste déroulante, sélectionnez les paramètres à synchroniser.
-
Cliquez sur Se connecter et activer, puis sélectionnez le compte avec lequel vous souhaitez synchroniser vos paramètres.
Une fois que vous êtes connecté, l’instance de VS Code que vous utilisez est immédiatement mise à jour pour afficher les derniers paramètres synchronisés.
Désactivation de la synchronisation des paramètres
Vous pouvez désactiver la synchronisation des paramètres pour arrêter la synchronisation des paramètres vers et depuis une instance de VS Code.
Par défaut, lorsque vous désactivez la synchronisation des paramètres, les nouveaux codespaces continuent d’utiliser les paramètres mis en cache la dernière fois que vos paramètres ont été poussés vers le cloud. Si vos codespaces continuent d’être créés avec les paramètres mis en cache, mais que vous souhaitez réutiliser à la place les paramètres VS Code par défaut dans vos codespaces, vous pouvez effacer le cache dans le cloud quand vous désactivez la synchronisation des paramètres.
-
Si la synchronisation des paramètres est actuellement désactivée dans votre instance de VS Code, vous devez d’abord l’activer. Pour les instructions, consultez Personnalisation de GitHub Codespaces pour votre compte.
-
En bas de la barre d’activité, sélectionnez et cliquez sur La synchronisation des paramètres est activée.
-
Dans la liste déroulante, cliquez sur Synchronisation des paramètres : Désactiver.
-
Pour effacer les paramètres mis en cache, dans la boîte de dialogue, sélectionnez Désactiver la synchronisation sur tous les appareils et effacer les données dans le cloud.
-
Cliquez sur Désactiver.
Dotfiles
Les dotfiles sont des fichiers et des dossiers sur des systèmes de type Unix commençant par ., qui contrôlent la configuration des applications et des interpréteurs de commandes sur votre système. Vous pouvez stocker et gérer vos dotfiles dans un référentiel sur GitHub. Pour des conseils et des tutoriels sur les éléments à inclure dans votre référentiel dotfiles, consultez GitHub et les dotfiles.
Votre référentiel dotfiles peut inclure vos alias et préférences d’interpréteur de commandes, tous les outils que vous souhaitez installer ou toute autre personnalisation de codespace que vous souhaitez effectuer.
Vous pouvez configurer GitHub Codespaces de manière à utiliser des dotfiles à partir de n’importe quel dépôt que vous possédez, en sélectionnant ce dépôt dans vos paramètres GitHub Codespaces personnels.
Lorsque vous créez un codespace, GitHub clone le dépôt de dotfiles sélectionné dans l’environnement codespace et recherche l’un des fichiers suivants pour configurer l’environnement.
- install.sh
- install
- bootstrap.sh
- bootstrap
- script/bootstrap
- setup.sh
- setup
- script/setup
Si aucun de ces fichiers n’est trouvé, les fichiers ou dossiers de votre référentiel dotfiles sélectionnés commençant par . sont liés par un lien symbolique au répertoire ~ ou $HOME du codespace.
Toutes les modifications apportées à votre référentiel dotfiles sélectionné s’appliquent uniquement à chaque nouveau codespace et n’affectent pas le codespace existant.
Remarque : Codespaces ne prend pas en charge la personnalisation des paramètres de portée utilisateur pour VS Code avec votre dépôt dotfiles. Vous pouvez définir les paramètres Espace de travail et de distance [Codespaces] distants pour un projet spécifique dans le référentiel du projet. Pour plus d’informations, consultez « Présentation des conteneurs de développement ».
Activation de votre référentiel dotfiles pour Codespaces
Vous pouvez utiliser votre dépôt dotfiles sélectionné pour personnaliser votre environnement GitHub Codespaces. Après avoir choisi votre référentiel dotfiles, vous pouvez y ajouter vos scripts, préférences et configurations. Vous devez ensuite activer vos dotfiles à partir de votre page de paramètres GitHub Codespaces personnels.
Avertissement : les dotfiles permettent d’exécuter des scripts arbitraires susceptibles de contenir du code inattendu ou malveillant. Avant d’installer un référentiel dotfiles, nous vous recommandons de vérifier que les scripts n’effectue aucune action inattendue.
-
Dans le coin supérieur droit d’une page, cliquez sur votre photo de profil, puis sur Paramètres.
-
Sous « Dotfiles », sélectionnez Installer automatiquement des dotfiles pour permettre à GitHub Codespaces d’installer automatiquement vos dotfiles dans chaque codespace que vous créez.
-
Utilisez la liste déroulante pour choisir le dépôt à partir duquel vous souhaitez installer les dotfiles.
Vous pouvez ajouter d’autres scripts, préférences, fichiers de configuration à votre référentiel dotfiles ou modifier des fichiers existants si vous le souhaitez. Les modifications apportées aux paramètres ne seront prises en compte que par les nouveaux codespaces.
Si votre codespace ne parvient pas à récupérer des paramètres de configuration à partir de fichiers dotfile, consultez « Résolution des problèmes liés aux options de personnalisation pour GitHub Codespaces ».
Autres paramètres disponibles
Vous pouvez également personnaliser GitHub Codespaces avec des options supplémentaires dans vos paramètres personnels :
- Pour activer la vérification GPG, consultez « Gestion de la vérification GPG pour GitHub Codespaces ».
- Pour définir votre éditeur, consultez « Définition de votre éditeur par défaut pour GitHub Codespaces ».
- Pour définir la durée pendant laquelle un codespace peut rester inutilisé avant d’être arrêté automatiquement, consultez « Définition de votre délai d’expiration pour GitHub Codespaces ».
- Pour définir la période pendant laquelle vos codespaces inutilisés sont conservés, consultez « Configuration de la suppression automatique de vos espaces de code ».
- Pour définir votre région par défaut, consultez « Définition de votre région par défaut pour GitHub Codespaces ».