nordic-dev.net/nix
nordic-dev.net/nix
2
0
Fork 0
mirror of https://github.com/NixOS/nix.git synced 2024-11-21 22:32:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: add documentation for gitea fetcher

Browse Source 
Signed-off-by: Tilman Andre Mix <tilmanmixyz@proton.me>
This commit is contained in:
Tilman Andre Mix 2024-09-09 20:28:18 +02:00
parent 7c417b47be
commit aad7eea009
No known key found for this signature in database
1 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
src/nix/flake.md
View File

@ -364,6 +364,33 @@ Currently the `type` attribute can be one of the following:
* `sourcehut:~misterio/nix-colors/182b4b8709b8ffe4e9774a4c5d6877bf6bb9a21c`
* `sourcehut:~misterio/nix-colors/21c1a380a6915d890d408e9f22203436a35bb2de?host=hg.sr.ht`
* `gitea`: Similar to `github`, is a more efficient way to fetch
Gitea/Forgejo repositories. The default host is `codeberg.org`.
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 `gitea` flakes is:
`gitea:<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 Gitea/Forgejo allows for self-hosting, you can specify `host` as
a parameter, to point to any instances other than `codeberg.org`.
Some examples:
* `gitea:redict/redict`
* `gitea:redict/redict/main`
* `gitea:redict/redict/a4c81102327bc2c74d229784a1d1dd680c708918`
* `gitea:lix-project/lix?host=git.lix.systems`
# Flake format
As an example, here is a simple `flake.nix` that depends on the