Skip to content

Ensure folks know to enable dotfiles while troubleshooting #18872

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed

Ensure folks know to enable dotfiles while troubleshooting #18872

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a6b51ea
Ensure folks know to enable dotfiles while troubleshooting
cdwort Jun 29, 2022
5f97b5d
Update content/codespaces/troubleshooting/troubleshooting-dotfiles-fo…
hubwriter Jul 1, 2022
00cfaca
Merge branch 'main' into patch-2
hubwriter Jul 1, 2022
9755e89
Put the image file in the repo
hubwriter Jul 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions content/codespaces/troubleshooting/troubleshooting-dotfiles-for-codespaces.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,13 @@ shortTitle: 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](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces) instead of private dotfiles.
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](/codespaces/troubleshooting/codespaces-logs#creation-logs).
2. Enable dotfiles by selecting **Automatically install dotfiles** in [your personal Codespaces settings](https://github.com/settings/codespaces).

![The 'Automatically install dotfiles' option](/assets/images/help/codespaces/automatically-install-dotfiles.png)

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](/codespaces/troubleshooting/codespaces-logs#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.