1
0
mirror of synced 2026-01-01 09:04:46 -05:00
Files
docs/content/codespaces/troubleshooting/troubleshooting-dotfiles-for-codespaces.md
hubwriter d82a62e0d6 Ensure folks know to enable dotfiles while troubleshooting (#28960)
* Add files for external contribution

* Optimize images

Co-authored-by: github-actions <github-actions@github.com>
2022-07-13 08:43:53 +00:00

1.7 KiB

title, intro, product, versions, type, topics, shortTitle
title intro product versions type topics shortTitle
Troubleshooting dotfiles for Codespaces Troubleshooting steps for common dotfiles issues. {% data reusables.gated-features.codespaces %}
fpt ghec
* *
reference
Codespaces
Dotfiles

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

  1. Make sure your dotfiles repository is public. If you have secrets or sensitive data you want to use in your codespace, use Codespace secrets instead of private dotfiles.

  2. Enable dotfiles by selecting Automatically install dotfiles in your personal Codespaces settings.

    The 'Automatically install dotfiles' option

  3. 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.
  4. 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.