把「點檔案」放到版本控制中

2019-10-03 20:52:00

通過在 GitLab 或 GitHub 上分享你的點檔案,可以在整個系統上備份或同步你的自定義設定。

通過隱藏檔案集(稱為點檔案dotfile)來客製化作業系統是個非常棒的想法。在這篇 中,H. Waldo Grunenwald 詳細介紹了為什麼以及如何設定點檔案的細節。現在讓我們深入探討分享它們的原因和方式。

什麼是點檔案?

點檔案dotfile”是指我們計算機中四處漂泊的組態檔。這些檔案通常在檔名的開頭以 . 開頭,例如 .gitconfig,並且作業系統通常在預設情況下將其隱藏。例如,當我在 MacOS 上使用 ls -a 時,它才會顯示所有可愛的點檔案,否則就不會顯示這些點檔案。

dotfiles on master? lsREADME.md  Rakefile   bin       misc    profiles   zsh-customdotfiles on master? ls -a.               .gitignore      .oh-my-zsh      README.md       zsh-custom..              .gitmodules     .tmux           Rakefile.gemrc          .global_ignore .vimrc           bin.git            .gvimrc         .zlogin         misc.gitconfig      .maid           .zshrc          profiles

如果看一下用於 Git 設定的 .gitconfig,我能看到大量的自定義設定。我設定了帳戶資訊、終端顏色偏好設定和大量別名,這些別名可以使我的命令列介面看起來就像我的一樣。這是 [alias] 塊的摘錄:

87   # Show the diff between the latest commit and the current state88   d = !"git diff-index --quiet HEAD -- || clear; git --no-pager diff --patch-with-stat"8990   # `git di $number` shows the diff between the state `$number` revisions ago and the current state91   di = !"d() { git diff --patch-with-stat HEAD~$1; }; git diff-index --quiet HEAD -- || clear; d"9293   # Pull in remote changes for the current repository and all its submodules94   p = !"git pull; git submodule foreach git pull origin master"9596   # Checkout a pull request from origin (of a github repository)97   pr = !"pr() { git fetch origin pull/$1/head:pr-$1; git checkout pr-$1; }; pr"

由於我的 .gitconfig 有 200 多行的自定義設定,我無意於在我使用的每一台新計算機或系統上重寫它,其他人肯定也不想這樣。這是分享點檔案變得越來越流行的原因之一,尤其是隨著社交編碼網站 GitHub 的興起。正式提倡分享點檔案的文章是 Zach Holman 在 2008 年發表的《點檔案意味著被複刻》。其前提到今天依然如此:我想與我自己、與點檔案新手,以及那些分享了他們的自定義設定從而教會了我很多知識的人分享它們。

分享點檔案

我們中的許多人擁有多個系統,或者知道硬碟變化無常,因此我們希望備份我們精心策劃的自定義設定。那麼我們如何在環境之間同步這些精彩的檔案?

我最喜歡的答案是分散式版本控制,最好是可以為我處理繁重任務的服務。我經常使用 GitHub,隨著我對 GitLab 的使用經驗越來越豐富,我肯定會一如既往地繼續喜歡它。任何一個這樣的服務都是共用你的資訊的理想場所。要自己設定的話可以這樣做:

  1. 登入到你首選的基於 Git 的服務。
  2. 建立一個名為 dotfiles 的儲存庫。(將其設定為公開!分享即關愛。)
  3. 將其克隆到你的本地環境。(你可能需要設定 Git 設定命令來克隆儲存庫。GitHub 和 GitLab 都會提示你需要執行的命令。)
  4. 將你的點檔案複製到該資料夾中。
  5. 將它們符號連結回到其目標資料夾(最常見的是 $HOME)。
  6. 將它們推播到遠端儲存庫。

上面的步驟 4 是這項工作的關鍵,可能有些棘手。無論是使用指令碼還是手動執行,工作流程都是從 dotfiles 資料夾符號連結到點檔案的目標位置,以便對點檔案的任何更新都可以輕鬆地推播到遠端儲存庫。要對我的 .gitconfig 檔案執行此操作,我要輸入:

$ cd dotfiles/$ ln -nfs .gitconfig $HOME/.gitconfig

新增到符號連結命令的標誌還具有其他一些用處:

  • -s 建立符號連結而不是硬連結。
  • -f 在發生錯誤時繼續做其他符號連結(此處不需要,但在迴圈中很有用)
  • -n 避免符號連結到一個符號連結檔案(等同於其他版本的 ln-h 標誌)

如果要更深入地研究可用引數,可以檢視 IEEE 和開放小組的 ln 規範以及 MacOS 10.14.3 上的版本。自從其他人的點檔案中拉取出這些標誌以來,我才發現了這些標誌。

你還可以使用一些其他程式碼來簡化更新,例如我從 Brad Parbs 復刻的 Rakefile。另外,你也可以像 Jeff Geerling 在其點檔案中那樣,使它保持極其簡單的狀態。他使用此 Ansible 劇本對檔案進行符號連結。這樣使所有內容保持同步很容易:你可以從點檔案的資料夾中進行 cron 作業或偶爾進行 git push

簡單旁註:什麼不能分享

在繼續之前,值得注意的是你不應該新增到共用的點檔案儲存庫中的內容 —— 即使它以點開頭。任何有安全風險的東西,例如 .ssh/ 資料夾中的檔案,都不是使用此方法分享的好選擇。確保在線上發布組態檔之前仔細檢查組態檔,並再三檢查檔案中沒有 API 令牌。

我應該從哪裡開始?

如果你不熟悉 Git,那麼我有關 Git 術語的文章和常用命令備忘清單將會幫助你繼續前進。

還有其他超棒的資源可幫助你開始使用點檔案。多年前,我就發現了 dotfiles.github.io,並繼續使用它來更廣泛地了解人們在做什麼。在其他人的點檔案中隱藏了許多秘傳知識。花時間瀏覽一些,大膽地將它們新增到自己的內容中。

我希望這是讓你在計算機上擁有一致的點檔案的快樂開端。

你最喜歡的點檔案技巧是什麼?新增評論或在 Twitter 上找我 @mbbroberg