forgejo/routers/api/v1/repo
Jade Lovelace 900381d6e9 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

(cherry picked from commit 6631f56ebf)
2024-05-29 18:50:14 +00:00
..
action.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08: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) (#30544) 2024-04-21 18:10:34 +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
file.go Add an immutable tarball link to archive download headers for Nix 2024-05-29 18:50:14 +00: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 Fix no edit history after editing issue's title and content (#30814) 2024-05-07 08:21:38 +01:00
issue_attachment.go Catch and handle unallowed file type errors in issue attachment API (#30791) 2024-05-07 08:12:34 +01:00
issue_comment.go remove util.OptionalBool and related functions (#29513) 2024-03-06 12:10:46 +08:00
issue_comment_attachment.go Catch and handle unallowed file type errors in issue attachment API (#30791) 2024-05-07 08:12:34 +01:00
issue_dependency.go Fix missed doer (#30231) (#30343) 2024-04-15 16:21:45 +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) (#30343) 2024-04-15 16:21:45 +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) (#30343) 2024-04-15 16:21:45 +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 Move context from modules to services (#29440) 2024-03-06 12:10:43 +08: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 Fix no edit history after editing issue's title and content (#30814) 2024-05-07 08:21:38 +01:00
pull_review.go Prevent re-review and dismiss review actions on closed and merged PRs (#30065) 2024-03-30 07:17:32 +01:00
release.go Fix release published actions not triggering for releases created from existing tags 2024-04-16 18:28:53 +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 Simplify mirror repository API logic (#30963) 2024-05-24 15:15:07 +02:00
repo_test.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
runners.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 Move context from modules to services (#29440) 2024-03-06 12:10:43 +08: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 Fix an actions schedule bug (#28942) 2024-03-25 16:27:32 +01:00