~sircmpwn/sr.ht-docs

97d5f17bfc5936f349afdfb9e59450b7c081530a — Drew DeVault 1 year, 5 months ago 3b97de0
git.sr.ht: document push options
3 files changed, 22 insertions(+), 0 deletions(-)

M git.sr.ht/api.md
M git.sr.ht/index.md
M terms.md
M git.sr.ht/api.md => git.sr.ht/api.md +8 -0
@@ 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.

M git.sr.ht/index.md => git.sr.ht/index.md +12 -0
@@ 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.

M terms.md => terms.md +2 -0
@@ 1,5 1,7 @@
---
title: Terms of Service
# TODO:
# - Explicitly prohibit the use of our services for cryptocurrency mining
---

These are the terms of service for sr.ht; please read them before using sr.ht.