Skip to content

README.md

Latest commit

 

History

History
49 lines (30 loc) · 1.63 KB

README.md

File metadata and controls

49 lines (30 loc) · 1.63 KB
Raw

dotfiles

My personal dotfiles repository. install.sh detects the runtime environment and runs the appropriate setup, so the same repo works for both GitHub Codespaces and local machines (macOS / Linux).

Installation

Codespaces

Register this repository as your dotfiles in your GitHub account settings, and install.sh will run automatically whenever a Codespace starts.

Settings page: https://github.com/settings/codespaces — see the "Dotfiles" section.

The Codespaces setup installs Emacs 30 (emacs-nox) from the ppa:ubuntuhandbook1/emacs PPA, which provides Emacs 30 packages for Ubuntu 22.04 and 24.04.

Local

git clone https://github.com/mahata/dotfiles.git ~/dotfiles
cd ~/dotfiles
./install.sh

install.sh decides which setup to run based on whether the CODESPACES environment variable is set:

  • If CODESPACES is set: runs install-codespaces.sh
  • Otherwise: runs install-local.sh

Logs

All output is printed to the terminal and also written to $HOME/dotfiles_install.log. Check that file when troubleshooting.

Tests

Tests live in tests/ and use bats-core.

brew install bats-core   # or: apt-get install bats
bats tests/

CI runs three jobs on every push and pull request:

  • shellcheck — lints the shell scripts.
  • bats — unit tests with stubbed external commands.
  • integration — runs install.sh inside the Codespaces base image (mcr.microsoft.com/devcontainers/universal) with CODESPACES=true and asserts that the login shell is left unchanged and that the git config symlink is created.

License

See LICENSE.