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

Merge pull request #7406 from amesgen/gitlab-fetcher

Browse source 
Document `gitlab` input scheme
This commit is contained in:
Théophane Hufschmitt 2023-03-31 13:21:55 +02:00 committed by GitHub
parent e32ca3cf16 a5ab253e8f
commit bb6e1244a3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 35 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
src/nix/flake.md
View file

@ -221,11 +221,46 @@ 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 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: