Skip to content

troubleshooting-dotfiles-for-codespaces.md

Latest commit

 

History

History
25 lines (20 loc) · 1.44 KB

troubleshooting-dotfiles-for-codespaces.md

File metadata and controls

25 lines (20 loc) · 1.44 KB
title Troubleshooting dotfiles for GitHub Codespaces
allowTitleToDifferFromFilename true
intro Troubleshooting steps for common dotfiles issues.
versions
fpt ghec
*
*
type reference
topics
Codespaces
shortTitle Dotfiles

If your codespace fails to pick up configuration settings from dotfiles, you should work through the following debugging steps.

  1. Enable dotfiles by selecting Automatically install dotfiles in your personal {% data variables.product.prodname_github_codespaces %} settings.

    The 'Automatically install dotfiles' option

  2. Check /workspaces/.codespaces/.persistedshare/dotfiles to see if your dotfiles were cloned.

    • If your dotfiles were cloned, try manually re-running your install script to verify that it is executable.
    • If your dotfiles were not cloned, check /workspaces/.codespaces/.persistedshare/EnvironmentLog.txt to see if there was a problem cloning them.

  3. Check /workspaces/.codespaces/.persistedshare/creation.log for possible issues. For more information, see Creation logs.

If the configuration from your dotfiles is correctly picked up, but part of the configuration is incompatible with codespaces, use the $CODESPACES environment variable to add conditional logic for codespace-specific configuration settings.