Merge branch 'axil-skip-compile' into 'main'

Document the skip compile GDK option

See merge request https://gitlab.com/gitlab-org/gitlab-development-kit/-/merge_requests/3977



Merged-by: Nao Hashizume <nhashizume@gitlab.com>
Approved-by: Nao Hashizume <nhashizume@gitlab.com>
Co-authored-by: Achilleas Pipinellis <axil@gitlab.com>

doc/configuration.md

@@ -310,6 +310,20 @@ or [truncating the Rails logs in `gitlab/log`](troubleshooting/ruby.md#truncate-
 | `gitlab.rails_background_jobs.verbose` | `false`  | Set this to `true` to increase the level of logging Sidekiq produces. |
 | `gitlab.rails_background_jobs.timeout` | `10`  | Set this to the number of seconds to ask Sidekiq to wait before forcibly terminating. |
 
+### Skip compile
+
+NOTE:
+The following settings are experimental and might change in the future.
+
+For some software, it's possible to download the pre-compiled binaries instead of
+compiling them.
+
+| Setting | Default | Description |
+|---------|---------|-------------|
+| `workhorse.skip_compile` | `false` | Set this to `true` and download a Workhorse pre-compiled binary from the [package registry](https://gitlab.com/gitlab-org/gitlab-development-kit/-/packages). |
+| `gitaly.skip_compile` | `false` | Set this to `true` and download a Gitaly pre-compiled binary from the [package registry](https://gitlab.com/gitlab-org/gitlab-development-kit/-/packages). |
+| `gitlab_shell.skip_compile` | `false` | Set this to `true` and download a GitLab Shell pre-compiled binary from the [package registry](https://gitlab.com/gitlab-org/gitlab-development-kit/-/packages). |
+
 ### GitLab Docs settings
 
 Under the `gitlab_docs` key, you can define the following settings:

doc/troubleshooting/asdf.md

@@ -93,3 +93,23 @@ Then it's likely `asdf` isn't sourced properly. Try these troubleshooting ideas:
 - Confirm your shell config file matches the [`asdf` instructions](https://asdf-vm.com/guide/getting-started.html#_3-install-asdf) for your chosen shell and install method.
   - For example, if you're using MacOS with Zsh and Homebrew then you could source `asdf` by adding `. /opt/homebrew/opt/asdf/libexec/asdf.sh` in the `.zshrc` file.
   - Double check your shell config file has the correct sourcing command. Some `asdf` instructions give you commands to copy and paste into the config file, while others are added indirectly after you run the command in your terminal. For example, in the `Zsh & Homebrew` instructions `echo -e "\n. $(brew --prefix asdf)/libexec/asdf.sh" >> ${ZDOTDIR:-~}/.zshrc` should be run by you in your terminal and not copy and pasted into `.zshrc`.
+
+## Conflicts with `mise`
+
+If you're using [`mise`](../howto/mise.md), but you still have `asdf` installed,
+you might see errors like the following:
+
+```plaintext
+Compiling gitlab/workhorse/gitlab-workhorse
+# sync/atomic
+compiler version "go1.22.5" does not match go tool version "go1.23.0"
+make[3]: *** [gitlab-resize-image] Error 1
+make[2]: *** [gitlab/workhorse/gitlab-workhorse] Error 2
+make[1]: *** [gitlab-workhorse-setup] Error 2
+make: *** [gitlab-workhorse-update-timed] Error 2
+```
+
+To solve this, uninstall one of the two dependency managers.
+
+If that still doesn't work, you can try and [download pre-compiled binaries](../configuration.md#skip-compile) of
+the software in question.