forgejo/routers/api/v1/repo
Jade Lovelace 6631f56ebf Add an immutable tarball link to archive download headers for Nix
This allows `nix flake metadata` and nix in general to lock a *branch*
tarball link in a manner that causes it to fetch the correct commit even
if the branch is updated with a newer version.

For further context, Nix flakes are a feature that, among other things,
allows for "inputs" that are "github:someuser/somerepo",
"https://some-tarball-service/some-tarball.tar.gz",
"sourcehut:~meow/nya" or similar. This feature allows our users to fetch
tarballs of git-based inputs to their builds rather than using git to
fetch them, saving significant download time.

There is presently no gitea or forgejo specific fetcher in Nix, and we
don't particularly wish to have one. Ideally (as a developer on a Nix
implementation myself) we could just use the generic tarball fetcher and
not add specific forgejo support, but to do so, we need additional
metadata to know which commit a given *branch* tarball represents, which
is the purpose of the Link header added here.

The result of this patch is that a Nix user can specify `inputs.something.url =
"https://forgejo-host/some/project/archive/main.tar.gz"` in flake.nix
and get a link to some concrete tarball for the actual commit in the
lock file, then when they run `nix flake update` in the future, they
will get the latest commit in that branch.

Example of it working locally:

 ยป nix flake metadata --refresh 'http://localhost:3000/api/v1/repos/jade/cats/archive/main.tar.gz?dir=configs/nix'
Resolved URL:  http://localhost:3000/api/v1/repos/jade/cats/archive/main.tar.gz?dir=configs/nix
Locked URL:    804ede182b.tar.gz?dir=configs
/nix&narHash=sha256-yP7KkDVfuixZzs0fsqhSETXFC0y8m6nmPLw2GrAMxKQ%3D
Description:   Computers with the nixos
Path:          /nix/store/s856c6yqghyan4v0zy6jj19ksv0q22nx-source
Revision:      804ede182b6b66469b23ea4d21eece52766b7a06
Last modified: 2024-05-02 00:48:32

For details on the header value, see:
56763ff918/doc/manual/src/protocols/tarball-fetcher.md
2024-05-03 15:21:45 -07:00
..
action.go feat(api): enhance Actions Secrets Management API for repository (#30656) 2024-04-28 15:39:01 +02:00
avatar.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
blob.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
branch.go Fix branch_protection api shows users/teams who has no readAccess (#30291) 2024-04-21 16:28:16 +02:00
collaborators.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
commits.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
compare.go Fix compare api swagger (#30648) 2024-04-28 15:39:00 +02:00
file.go Add an immutable tarball link to archive download headers for Nix 2024-05-03 15:21:45 -07:00
flags.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
fork.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
git_hook.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
git_ref.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
hook.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
hook_test.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
issue.go Enable more revive linter rules (#30608) 2024-04-28 15:39:00 +02:00
issue_attachment.go Fix missed doer (#30231) 2024-04-15 20:01:35 +02:00
issue_comment.go Do some performance optimize for issues list and view issue/pull (gitea#29515) 2024-04-08 14:47:31 +02:00
issue_comment_attachment.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
issue_dependency.go Fix missed doer (#30231) 2024-04-15 20:01:35 +02:00
issue_label.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
issue_pin.go Fix missed doer (#30231) 2024-04-15 20:01:35 +02:00
issue_reaction.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
issue_stopwatch.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
issue_subscription.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
issue_tracked_time.go Fix missed doer (#30231) 2024-04-15 20:01:35 +02:00
key.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
label.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
language.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
main_test.go make writing main test easier (#27270) 2023-09-28 01:38:53 +00:00
migrate.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
milestone.go remove util.OptionalBool and related functions (#29513) 2024-03-06 12:10:46 +08:00
mirror.go Enable more revive linter rules (#30608) 2024-04-28 15:39:00 +02:00
notes.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
patch.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
pull.go Enable more revive linter rules (#30608) 2024-04-28 15:39:00 +02:00
pull_review.go Prevent allow/reject reviews on merged/closed PRs (#30686) 2024-04-28 15:39:01 +02:00
release.go [FEAT]Add Option to hide Release Archive links (#3139) 2024-04-24 15:15:55 +00:00
release_attachment.go Add support for API blob upload of release attachments (#29507) 2024-03-06 12:10:46 +08:00
release_tags.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
repo.go Enable more revive linter rules (#30608) 2024-04-28 15:39:00 +02:00
repo_test.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
star.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
status.go Cache repository default branch commit status to reduce query on commit status table (#29444) 2024-03-11 23:36:58 +07:00
subscriber.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
tag.go Count downloads for tag archives 2024-04-08 12:51:27 +02:00
teams.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
topic.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
transfer.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
tree.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
wiki.go Enable more revive linter rules (#30608) 2024-04-28 15:39:00 +02:00