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

BRAVO68WEB · mafredri · matifali · web-flow · commit 65583eca47f6 · 2023-07-21T18:39:50.000Z
* 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 &lt;mafredri@gmail.com&gt;
Co-authored-by: Muhammad Atif Ali &lt;matifali@live.com&gt;
diff --git a/cli/dotfiles.go b/cli/dotfiles.go
@@ -193,6 +193,18 @@ func (r *RootCmd) dotfiles() *clibase.Cmd {
 				}
 
 				_, _ = fmt.Fprintf(inv.Stdout, "Running %s...\n", script)
+
+				// Check if the script is executable and notify on error
+				scriptPath := filepath.Join(dotfilesDir, script)
+				fi, err := os.Stat(scriptPath)
+				if err != nil {
+					return xerrors.Errorf("stat %s: %w", scriptPath, err)
+				}
+
+				if fi.Mode()&0o111 == 0 {
+					return xerrors.Errorf("script %q is not executable. See https://coder.com/docs/v2/latest/dotfiles for information on how to resolve the issue.", script)
+				}
+
 				// it is safe to use a variable command here because it's from
 				// a filtered list of pre-approved install scripts
 				// nolint:gosec
diff --git a/docs/dotfiles.md b/docs/dotfiles.md
@@ -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
+```
