Skip to content

Commit ff46ece

Browse files
committed
Document discovery document inputs
1 parent a87b2a2 commit ff46ece

1 file changed

Lines changed: 23 additions & 0 deletions

File tree

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ This action sets up zb for use in GitHub Actions by:
1515
1616
## Reference
1717
18+
All inputs are optional.
19+
1820
```yaml
1921
- uses: 256lights/setup-zb@v1
2022
with:
@@ -40,6 +42,27 @@ This action sets up zb for use in GitHub Actions by:
4042
]
4143
}
4244
45+
# Binary cache discovery document for downloading.
46+
server-download-discovery: >-
47+
{
48+
"_links": {
49+
"https://zb-build.dev/api/rel/narinfo": [
50+
{"href": "https://www.example.com/{digest}.narinfo", "templated": true}
51+
]
52+
}
53+
}
54+
55+
# Binary cache discovery document for uploading.
56+
server-upload-discovery: >-
57+
{
58+
"_links": {
59+
"https://zb-build.dev/api/rel/nar": {"href": "https://www.example.com/{digest}.nar", "templated": true},
60+
"https://zb-build.dev/api/rel/narinfo": [
61+
{"href": "https://www.example.com/{digest}.narinfo", "templated": true}
62+
]
63+
}
64+
}
65+
4366
# Signing key to use in the server.
4467
# Store this in a GitHub Actions secret:
4568
# https://docs.github.com/en/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets

0 commit comments

Comments
 (0)