lix-project/lix
20
58
Fork 31
Code Issues 355 Code Review (Gerrit) Projects 3 Releases Wiki Activity

Document gitlab input scheme

Browse source
This commit is contained in:
amesgen 2022-12-06 00:16:25 +01:00 committed by Alexander Esgen
parent bfcf30f0ab
commit 105677140d
No known key found for this signature in database
GPG key ID: 19039F88073CC126
1 changed files with 31 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
src/nix/flake.md
View file

@ -222,6 +222,37 @@ Currently the `type` attribute can be one of the following:
* `github:edolstra/dwarffs/unstable` * `github:edolstra/dwarffs/unstable`
* `github:edolstra/dwarffs/d3f2baba8f425779026c6ec04021b2e927f61e31` * `github:edolstra/dwarffs/d3f2baba8f425779026c6ec04021b2e927f61e31`
* `gitlab`: Similar to `github`, is a more efficient way to fetch
GitLab repositories. The following attributes are required:
* `owner`: The owner of the repository.
* `repo`: The name of the repository.
Like `github`, these are downloaded as tarball archives.
The URL syntax for `gitlab` flakes is:
`gitlab:<owner>/<repo>(/<rev-or-ref>)?(\?<params>)?`
`<rev-or-ref>` works the same as `github`. Either a branch or tag name
(`ref`), or a commit hash (`rev`) can be specified.
Since GitLab allows for self-hosting, you can specify `host` as
a parameter, to point to any instances other than `gitlab.com`.
Some examples:
* `gitlab:veloren/veloren`
* `gitlab:veloren/veloren/master`
* `gitlab:veloren/veloren/80a4d7f13492d916e47d6195be23acae8001985a`
* `gitlab:openldap/openldap?host=git.openldap.org`
When accessing a project in a (nested) subgroup, make sure to URL-encode any
slashes, i.e. replace `/` with `%2F`:
* `gitlab:veloren%2Fdev/rfcs`
* `sourcehut`: Similar to `github`, is a more efficient way to fetch * `sourcehut`: Similar to `github`, is a more efficient way to fetch
SourceHut repositories. The following attributes are required: SourceHut repositories. The following attributes are required: