From 2a120b71d75b438acdac8e6dee2ba3e8cbed13b2 Mon Sep 17 00:00:00 2001 From: Andrei Jiroh Eugenio Halili Date: Wed, 29 Sep 2021 18:30:57 +0800 Subject: [PATCH] wrote more docs for myself + add note on its existence on README --- bootstrap | 6 ++++-- docs/variables.md | 15 +++++++++++++++ 2 files changed, 19 insertions(+), 2 deletions(-) create mode 100644 docs/variables.md diff --git a/bootstrap b/bootstrap index cd4e82f..2a93976 100755 --- a/bootstrap +++ b/bootstrap @@ -261,7 +261,7 @@ installShellCheck() { scversion="stable" # or "v0.4.7", or "latest" SHELLCHECK_ARCHIVE_URL="https://github.com/koalaman/shellcheck/releases/download/${scversion?}/shellcheck-${scversion?}.linux.x86_64.tar.xz" # TODO: Also detect other arches, especially on i386 - if [[ $SKIP_DEPENDENCY_INSTALL == "" ]]; then + if [[ $LSKIP_DEPENDENCY_INSTAL == "" ]]; then current_shellcheck_path=$(command -v shellcheck) isOwnedByUser="$(find $PREFIX/bin -user $USER -name shellcheck)" current_path_dir="$(dirname $current_shellcheck_path)" @@ -414,10 +414,12 @@ main() { installCode # step 5: copy and symlink files - cloneSecretsRepo # Run this before we even copy the ssh keys! copyGitConfig copyNanoConfig copyBashrc + + # step 5.2: copy our secrets btw + cloneSecretsRepo # Run this before we even copy the ssh keys! copyKeysSSH # step 6: finally clean up bullshit diff --git a/docs/variables.md b/docs/variables.md new file mode 100644 index 0000000..d438d09 --- /dev/null +++ b/docs/variables.md @@ -0,0 +1,15 @@ +# Supprted variables for bootstrap script + +This list is non-exhastive and may be out of date. The bootstrap script's source code might contains them all. + +| Variable name | description | Type | +| --- | --- | --- | +| `USE_CODE_SERVER` | Installs code-server to use VS Code in a web browser. | Bootstrap flag | +| `USE_GH_SECRETS_MIRROR` | Use GitHub mirror for the dotfiles-secrets repo, requires the GitHub CLI to be installed for this process. | Botstrap flag | +| `USE_NVM` | Use Node Version Manager to install Node.js instead of NodeSource's way. May require you to install build tools if nvm went to installing from source, especially if you're on i386. | +| `DOTFILES_OS_NAME` | OS detection mechanisms for various automated steps in the bootstrap script. | OS detection system | +| `GOOGLE_CLOUD_SHELL` | Used to detect Cloud Shell environment | OS detectio system +| `GITLAB_LOGIN` | GitLab SaaS username for cloning the secrets repo, for validation purposes only. | Bootstrap flag | +| `GITLAB_TOKEN` | GitLab SaaS personal access token for cloning the secrets repo, not needed if `USE_GH_SECRETS_MIRROR` is being used | Bootstrap flag | +| `SKIP_CONFIG_LINKING` | Skips the process of symlinking config files to their destinations | Bootstrap flag | +| `SKIP_DEPENDENCY_INSTAL` | Skips installation of ShellCheck and other tooling and stuff | Bootstrap flag |