wrote more docs for myself + add note on its existence on README

This commit is contained in:
Andrei Jiroh Eugenio Halili 2021-09-29 18:30:57 +08:00
parent b6d41ada49
commit 2a120b71d7
2 changed files with 19 additions and 2 deletions

View File

@ -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

15
docs/variables.md Normal file
View File

@ -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 |