Restore ShellCheck CI and harden install, credentials, and first-run docs - #1
Merged
Merged
Conversation
…docs History rewrite dropped .github/workflows/shellcheck.yml while README still linked it, so the public listing had a broken badge and no lint on main. Re-add CI (bash -n + ShellCheck) and the community files the README already points at. install.sh looked for launchd plists in the parent of the repo, so a fresh clone could not register agents. Load plists from the script directory, refuse placeholder volume paths, and make uninstall.sh a matching launchd cleanup. Pass the restic password with RESTIC_PASSWORD_COMMAND instead of exporting RESTIC_PASSWORD, auto-detect Intel vs Apple Silicon restic paths, and treat a failed cold-backup tier as an error instead of ok. Co-authored-by: andersyin <andersyin@users.noreply.github.com>
andersyin
marked this pull request as ready for review
August 13, 2026 04:21
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This toolkit was just listed in awesome-restic (PR #49), but
mainwas not in a trustworthy state for new visitors:20a922d, then a follow-up commit went green — after a history rewrite those CI/community files were gone while README still linked them (broken badge, missingCONTRIBUTING.md/ issue templates).install.shloaded launchd plists from the parent of the repo, so a fresh clone could not register agents.This PR restores CI, fixes that install bug, and lands a small set of robustness/docs changes rather than new backup features.
What changed
CI / public listing
.github/workflows/shellcheck.yml:bash -nplus ShellCheck at warning severity on push/PR.CONTRIBUTING.mdand issue/PR templates that README already linked.RESTIC_PASSWORD_COMMANDnotes.Install / uninstall (launchd)
__SCRIPT_DIR__substitution), not../.config.shstill hasYourWorkDrive/YourArchiveDrive/YourBackupDriveplaceholders.uninstall.shnow usesset -euo pipefail, the same agent list, and documents that backup data and the Keychain item are kept.Script robustness
RESTIC_PASSWORD_COMMAND(Keychain). Scripts no longerexport RESTIC_PASSWORD./opt/homebrew/binthen/usr/local/bin.daily-work-mirror.shhonorsWARN_PCT/ABORT_PCTand no longer strips the leading zero from hour00(midnight night window).error, notok.set -uo pipefail(orset -euo pipefailwhere failures should abort).Testing
Linux CI cannot run macOS launchd/Keychain/restic jobs; this PR does not invent those tests.
Locally on this branch:
Please confirm GitHub Actions ShellCheck is green on this PR before merging. After merge, a smoke test on a Mac is: edit
config.shoff the placeholders, add the Keychain item,bash install.sh, thenbash uninstall.sh.