Automatizácia synchronizácie Obsidian vaultu pomocou make a shell skriptov¶
Vítam vás pri tretom diele našej série o budovaní nezávislej, lokal-first znalostnej databázy. V prvej časti sme sa pozreli na pluginy Obsidianom. V druhom článku sme nastavili Obsidian a Termux na Android zariadení pre prácu na cestách.
Teraz, keď Obsidian aktívne používame na viacerých zariadeniach (PC, notebook, mobil), narážame na klasickú výzvu: ako zabezpečiť plynulú a automatickú synchronizáciu bez ručného vyklikávania git príkazov a konfliktov?
Riešením je pár prenosných shell skriptov a jedného Makefile, ktoré fungujú rovnako na Linuxe, macOS aj Windows.
1. Príprava prostredia na rôznych OS¶
Vďaka použitiu štandardných POSIX shell skriptov je toto riešenie 100% prenosné. Potrebujete len git, bash a make.
Linux (Debian / Ubuntu / Raspberry Pi OS)¶
Na Linuxových distribúciách je inštalácia otázkou jedného príkazu:
macOS¶
Na systéme macOS sú git aj bash prítomné natívne. Pre sprístupnenie príkazu make stačí nainštalovať Xcode Command Line Tools:
Windows¶
Pre spúšťanie shell skriptov a príkazu make na Windows odporúčam použiť git Bash:
- Stiahnite a nainštalujte git for Windows (súčasťou je terminál git Bash).
- Stiahnite si samostatný binárny súbor
makepre Windows (napr. cez balíčkovací správca Chocolatey:choco install makealebo cez scoop:scoop install make). - Prípadne môžete využiť WSL (Windows Subsystem for Linux) pre plnohodnotné Linuxové prostredie.
Poznámka k vzdialenému repozitáru: Ak nemáte vlastný git server, môžete ako vzdialené úložisko použiť akúkoľvek hostovanú službu typu GitHub, GitLab alebo Codeberg.
2. Prečo práve samostatné shell skripty?¶
Možno ste už na chodbe alebo pri kávovare v kuchynke počuli vývojárov hovoriť o nočných morách z masívnych mergov/rebasov (merge conflict). Presne tohto strachu sa pri automatizácii chceme vyhnúť. Ak spravíte jeden obrovský commit pre desiatky upravených, vytvorených aj zmazaných poznámok naraz, riziko konfliktov rapídne stúpa.
Preto ja používam logiku “1 commit per file” (jeden commit na každý jeden súbor). Samozrejme, konfliktom sa stopercentne nevyhneme — ak omylom upravíte presne tie isté riadky v tej istej poznámke na dvoch rôznych zariadeniach pred synchronizáciou, git bude vyžadovať vašu pozornosť. Avšak rozdelením zmien ich pravdepodobnosť a dopad minimalizujeme na najnižšiu možnú mieru.
Takže logika synchronizácie je nasledovná:
-
Najprv pridať nové súbory (commit-new-files.sh)
-
Potom commitnúť modifikované súbory (commit-modified-files.sh)
-
Nakoniec vyriešiť odstránenie zmazaných súborov (commit-deleted-files.sh)
Nezabudnite na git konfiguráciu
Pred spustením skriptov sa uistite, že máte správne nastavenú globálnu aj lokálnu git konfiguráciu (meno, e-mail a autostash).
Písal som o tom napr tuto
Takto to používam ja:
# Globálna konfigurácia gitu
git config --global push.autoSetupRemote true
git config --global init.defaultBranch main
git config --global pull.rebase true
git config --global rebase.autoStash true
Toto si nastavte podľa seba:
3. shell skripty¶
Aby sme sa vyhli zbytočným konfliktom pri spájaní zmien (merge), rozdelíme automatické commitovanie do troch samostatných krokov podľa stavu súborov: nové, odstránené a zmenené.
Všetky tri skripty uložte do priečinka ./bin/ vo vašom Obsidian vaulte. Prístupové práva (chmod +x ./bin/*.sh) riešíť nemusíte, na Androide to nepomôže kvôli typu súborového systému.
bin/commit-new-files.sh¶
Tento skript vyhľadá všetky novovytvorené súbory a vytvorí pre každý z nich samostatný commit:
#!/bin/bash
git ls-files -z --others --exclude-standard \
| xargs -0 -I{} sh -c 'git add -- "{}" && git commit -m "Add {}" "{}"'
bin/commit-deleted-files.sh¶
Skript pre detekciu a commit zmazaných súborov:
#!/bin/bash
git ls-files -z --deleted --others --exclude-standard \
| xargs -0 -I{} sh -c 'git add -- "{}" && git commit -m "Deleted {}" "{}"'
bin/commit-modified-files.sh¶
Skript pre zaznamenanie úprav v existujúcich poznámkach:
#!/bin/bash
git ls-files -z --modified --others --exclude-standard \
| xargs -0 -I{} sh -c 'git add -- "{}" && git commit -m "Update {}" "{}"'
4. Srdce automatizácie: Makefile¶
Všetku logiku spájame do jedného súboru Makefile, ktorý umiestnime priamo do koreňového priečinka Obsidian vaultu.
Tento Makefile spĺňa tri hlavné úlohy:
1. Automatické predpripravenie denníka: Vytvára priečinok pre záznamy na nasledujúci mesiac v priečinku Diary/. O tomto viac niekedy inokedy.
2. Postupná synchronizácia: Vykoná commity, stiahne zmeny zo servera (pull) a odpošle lokálne zmeny (push).
3. Udržiavanie čistoty (Clean): Vymaže prázdne dočasné súbory typu Untitled.md alebo Untitled.canvas.
.DEFAULT_GOAL := all
.PHONY: help
help: ## Zobrazí túto nápovedu
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
all: sync
sync: ## Synchronizuje Obsidian vault so serverom
mkdir -p "Diary/$$(date --date='next month' +'%Y-%m')"
-$(MAKE) commit
-$(MAKE) pull
$(MAKE) push
commit: ## Vytvorí lokálne commity pre všetky zmeny
-bash ./bin/commit-new-files.sh
-bash ./bin/commit-deleted-files.sh
-bash ./bin/commit-modified-files.sh
pull: ## Stiahne najnovšiu verziu zo servera
git pull
push: ## Odošle lokálne zmeny na server
git push
clean: ## Vyčistí prázdne Untitled dokumenty a prázdne adresáre
find . -type f -name 'Untitled*.md' -size 0 -ls -delete
find . -type f -name 'Untitled*.canvas' -size 2c -ls -delete
find . -type d -name 'Untitled*' -empty -ls -delete
5. Ako to používať v praxi?¶
Teraz vám namiesto zložitej série git príkazov stačí v termináli zadať jediný príkaz:
Ak chcete vyhľadať a odstrániť prázdne “Untitled” poznámky, ktoré vzniknú náhodným kliknutím na vytvorenie novej poznámky v Obsidiane, spustite:
A ak si neviete spomenúť na dostupné príkazové ciele, príkaz make help vám prehľadne zobrazí nápovedu vytvorenú priamo z komentárov v Makefile.