feat(cli): check if dotfiles install script is executable (#8588)

* feat(cli): check if dotfiles install script is executable

* feat(docs): add section for dotfiles setup and document executable fix

---------

Co-authored-by: Mathias Fredriksson <mafredri@gmail.com>
Co-authored-by: Muhammad Atif Ali <matifali@live.com>
This commit is contained in:
Jyotirmoy Bandyopadhyaya
2023-07-21 18:39:50 +00:00
committed by GitHub
co-authored by Mathias Fredriksson Muhammad Atif Ali
parent 7f67000b90
commit 65583eca47
2 changed files with 36 additions and 0 deletions
+24
View File
@@ -60,3 +60,27 @@ sudo apt update
# Install some of my favorite tools every time my workspace boots
sudo apt install -y neovim fish cargo
```
## Setup script support
User can setup their dotfiles by creating one of the following script files in their dotfiles repo:
- `install.sh`
- `install`
- `bootstrap.sh`
- `bootstrap`
- `script/bootstrap`
- `setup.sh`
- `setup`
- `script/setup`
If any of the above files are found (in the specified order), Coder will try to execute the first match. After the first match is found, other files will be ignored.
The setup script must be executable, otherwise the dotfiles setup will fail. If you encounter this issue, you can fix it by making the script executable using the following commands:
```shell
cd <path_to_dotfiles_repo>
chmod +x <script_name>
git commit -m "Make <script_name> executable" <script_name>
git push
```