SQ-GIT(1)

✨ SQ-GIT(1) ✨

okay bestie, pull up a chair, we're reading a man page and it's literally gonna be fun 💅 This one lives in the User Commands section of the manual, it's called sq-git, and this particular page is all about one lil subcommand. Let's go 🦋

---

🌸 NAME 🌸

sq-git-update-hook — a git update hook that enforces the policy. That's the whole vibe. It's a hook, it checks the policy, no cap. ✨

---

🎀 SYNOPSIS 🎀

sq-git update-hook [OPTIONS] REF_NAME OLD_OBJECT NEW_OBJECT

---

🦋 DESCRIPTION 🦋

So it's a git update hook that enforces the policy. Simple as that, but the way it does it is lowkey iconic. 👑

To make it actually do its thing, you drop this line into hooks/update on the shared git server, and boom — it enforces the policy that's embedded in the repository, starting at the trust root COMMIT:

sq-git update-hook --trust-root=<COMMIT> "$@"

Now here's the tea on how it decides stuff. 🍓

When a branch is pushed that is not previously known to the server, sq-git update-hook checks that all commits starting from the trust root to the pushed commit adhere to the policy. Fresh branch, full vibe check, every commit from the trust root down. ✅

When a branch is pushed that is previously known to the server, i.e. the branch is updated, sq-git update-hook checks that all new commits starting from the commit previously known to the server to the pushed commit adhere to the policy. So it's not re-checking the whole history, just the new stuff. Efficient queen. 💖

But wait, plot twist 😭 — if there is no path from the previously known commit to the new one, that means the branch has been rebased. And then? We fall back to searching for a path from the trust root. Periodt.

---

✨ OPTIONS ✨

💅 Subcommand options

• --policy-file=POLICY — Use an alternate policy. The default policy is the openpgp-policy.toml file in the root of the repository's working tree. So if you don't say anything, that's the one it grabs. 🌈
• --trust-root=COMMIT — The commit to use as a trust root. This is your starting point, your anchor, your main character commit. ⭐
• REF_NAME — The name of the ref being updated. Supplied as the first argument to the update hook, see githooks(5). 👑
• OLD_OBJECT — The old object name stored in the ref. Supplied as the second argument to the update hook, see githooks(5). 🎀
• NEW_OBJECT — The new object name stored in the ref. Supplied as third argument to the update hook, see githooks(5). 🦋

🧚 Global options

• See sq-git(1) for a description of the global options. That's where all the global bestie knowledge lives. 💜

---

🔥 SEE ALSO 🔥

• sq-git(1).
• For the full documentation see <https://sequoia-pgp.gitlab.io/sequoia-git>. (yes that URL has a soft hyphen in the original, we're keeping it, iykyk 🙈)

---

💖 VERSION 💖

0.6.0

---

and that's the whole page, bestie 🫶 This icon was brought to you by Sequoia PGP, version 0.6.0, dated 0.6.0 — same number twice, we love a consistent queen. Now go enforce that policy. Slay. 💅✨🎀