From 97d5f17bfc5936f349afdfb9e59450b7c081530a Mon Sep 17 00:00:00 2001
From: Drew DeVault <sir@cmpwn.com>
Date: Mon, 17 Feb 2020 11:51:08 -0500
Subject: git.sr.ht: document push options

---
 git.sr.ht/api.md   |  8 ++++++++
 git.sr.ht/index.md | 12 ++++++++++++
 2 files changed, 20 insertions(+)

(limited to 'git.sr.ht')

diff --git a/git.sr.ht/api.md b/git.sr.ht/api.md
index 5edc6e7..0c16dc1 100644
--- a/git.sr.ht/api.md
+++ b/git.sr.ht/api.md
@@ -405,6 +405,7 @@ executing `git push`. Your server has 5 seconds to respond to the HTTP request.
 ```json
 {
   "push": "uuid assigned to this push event",
+  "push-options": { map of push options },
   "pusher": { user resource },
   "refs": [
     {
@@ -425,3 +426,10 @@ executing `git push`. Your server has 5 seconds to respond to the HTTP request.
   ]
 }
 ```
+
+**Notes**
+
+- Push options (specified via `git push -o <option>`) are interpreted as
+  `key=value`, and the map is populated as such. For example, `git push -o
+  foo=bar` would result in `{"foo": "bar"}`. Options specified without a value -
+  e.g. `-o foo` - will have their value set to an empty string.
diff --git a/git.sr.ht/index.md b/git.sr.ht/index.md
index bda578a..6c65b91 100644
--- a/git.sr.ht/index.md
+++ b/git.sr.ht/index.md
@@ -113,3 +113,15 @@ repositories are hidden unless you're logged in.
 
 The information displayed on your profile page is sourced from your [meta.sr.ht
 profile](/meta.sr.ht#profile).
+
+## Push Options
+
+git.sr.ht supports some git push options, which can be specified with `-o
+option` or `-o option=value`.
+
+- **debug**: prints the UUID assigned to your git push. You may be asked to
+  provide this when troubleshooting push issues for your account.
+- **skip-ci**: skips submitting builds.sr.ht jobs for this push.
+
+All of your push options, including ones not recognized by git.sr.ht itself, are
+forwarded to any webhooks you have configured for your repository.
-- 
cgit