Mention host parameter for GitHub

This commit is contained in:
amesgen 2022-12-06 00:16:26 +01:00 committed by Alexander Esgen
parent 105677140d
commit a5ab253e8f
No known key found for this signature in database
GPG key ID: 19039F88073CC126

View file

@ -216,11 +216,15 @@ Currently the `type` attribute can be one of the following:
commit hash (`rev`). Note that unlike Git, GitHub allows fetching by commit hash (`rev`). Note that unlike Git, GitHub allows fetching by
commit hash without specifying a branch or tag. commit hash without specifying a branch or tag.
You can also specify `host` as a parameter, to point to a custom GitHub
Enterprise server.
Some examples: Some examples:
* `github:edolstra/dwarffs` * `github:edolstra/dwarffs`
* `github:edolstra/dwarffs/unstable` * `github:edolstra/dwarffs/unstable`
* `github:edolstra/dwarffs/d3f2baba8f425779026c6ec04021b2e927f61e31` * `github:edolstra/dwarffs/d3f2baba8f425779026c6ec04021b2e927f61e31`
* `github:internal/project?host=company-github.example.org`
* `gitlab`: Similar to `github`, is a more efficient way to fetch * `gitlab`: Similar to `github`, is a more efficient way to fetch
GitLab repositories. The following attributes are required: GitLab repositories. The following attributes are required: