git: add repository and remote archive support by aymanbagabas · Pull Request #2013 · go-git/go-git

aymanbagabas · 2026-04-24T18:44:31Z

This implements the high level porcelain end of git-upload-archive and the git archive equivalent APIs. It adds a repo.Archive(opts) and git.ArchiveRemote(url, opts) methods to create archives of local and remote repositories.

This continues the work that was introduced in #1986

aymanbagabas · 2026-04-24T19:09:29Z

+	"github.com/stretchr/testify/require"
+)
+
+func TestArchiveRemote(t *testing.T) {


We already test the remote transport logic in our git transport tests. This ensures the high-level API does validation.

pjbgf

Overall, LGTM. Let's just tighten the validation on ArchiveOptions please as per comment below.

pjbgf · 2026-05-06T11:03:40Z

+}
+
+// Validate validates the ArchiveOptions.
+func (o *ArchiveOptions) Validate() error {


Let's add stricter rules here please, for example:

Format must be empty or one of tar, tar.gz, tgz, zip.

Prefix must be empty or a valid path component, not containing ...

Treeish must be a sha1/sha256 valid hex, or a valid heads name.

Paths must be empty, or a valid relative path not containing ...

Hey @pjbgf,

I made some changes to validate the treeish during git.Archive and before calling WriteArchive. The rules here are intentional for different reasons.

For Format, we do the validation in git.Archive because a remote server and git.ArchiveRemote can have different supported archive formats than local.

The Prefix here is the prepended prefix component added to the files being archived. Canonical git allows path components containing ../ and leave unsafe non-normalized prefixes to be the responsibility of the extractor. Many tar and unzip tools reject extracting to ../ by default.

Since we moved resolving the tree before actually calling WriteArchive, we validate the tree is valid and has either valid sha1/sha256 or valid heads.

Paths are just filters, if a path doesn't exist, we already return pathspec did not match any files similar to canonical git. This validation cannot happen during Validate without resolving the tree and start writing the archive.

@pjbgf Prefix now rejects paths with .. components and absolute paths.

Copilot

Pull request overview

Adds porcelain-level archive creation APIs to the git package, enabling git archive-like behavior for local repositories and git archive --remote-like behavior via git-upload-archive, building on the existing transport-layer support.

Changes:

Introduces Repository.Archive(opts) / Repository.ArchiveContext(ctx, opts) for streaming local repository archives.
Adds ArchiveRemote(url, opts) / ArchiveRemoteContext(ctx, url, opts) to request archives from remote repositories using git-upload-archive.
Refactors internal archive generation to resolve tree-ish metadata separately and expands tests around formats/prefix/path filtering.

Show a summary per file

File	Description
repository.go	Adds `ArchiveOptions` and local repository archive streaming APIs.
archive.go	Adds remote archive entrypoints that handshake and invoke `git-upload-archive`.
internal/archive/archive.go	Refactors archive generation API to accept a resolved tree + commit metadata; adds `ErrUnsupportedFormat`.
plumbing/transport/upload_archive.go	Updates server-side `UploadArchive` to resolve tree-ish before writing the archive.
repository_test.go	Adds coverage for local repository archive generation (formats/prefix/path filtering/cancellation).
archive_test.go	Adds unit tests for `ArchiveOptions.Validate` and basic `ArchiveRemote` argument/validation behavior.

Copilot's findings

Comments suppressed due to low confidence (1)

archive_test.go:122

These parallel subtests capture the range variable tt. Since tt is reused across iterations, t.Parallel() can lead to subtests using the wrong url/options/wantErr values. Rebind tt := tt (or switch to an index loop) before t.Run.

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			t.Parallel()
			_, err := ArchiveRemote(tt.url, tt.opts)

Files reviewed: 6/6 changed files
Comments generated: 6

+	return arch.Archive(ctx, &transport.ArchiveRequest{
+		Args:     args,
+		Progress: o.Progress,
+	})


Copilot

Copilot's findings

Files reviewed: 6/6 changed files
Comments generated: 7

Copilot

Copilot's findings

Files reviewed: 7/7 changed files
Comments generated: 7

aymanbagabas · 2026-05-09T18:38:20Z

+			name:    "remote allows custom format",
+			url:     "file:///tmp/repo.git",
+			opts:    &ArchiveOptions{Format: "tar.xz", Treeish: "master"},
+			wantErr: "",
+		},


File here is the transport and our client resolved the url to our default file transport. Custom transports can be added via ClientOptions. If a transport is not supported or valid, we error during the construction of client.

Copilot

Copilot's findings

Comments suppressed due to low confidence (2)

archive_test.go:136

The subtests run with t.Parallel() but capture the range variable tt from the outer loop. Rebind tt := tt inside the loop before t.Run to avoid all subtests using the last case / racing.

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			t.Parallel()
			_, err := ArchiveRemote(tt.url, tt.opts)
			if tt.wantErr == "" {

archive_test.go:213

The subtests run with t.Parallel() but capture the range variable tt from the outer loop. Rebind tt := tt inside the loop before t.Run (this also ensures each subtest uses the intended tt.opts pointer).

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			t.Parallel()

			rc, err := ArchiveRemote(repoURL, tt.opts)
			require.NoError(t, err)

Files reviewed: 7/7 changed files
Comments generated: 5

+	base := t.TempDir()
+	repoFS := test.PrepareRepository(t, fixtures.Basic().One(), base, "basic.git")
+	repoPath, err := filepath.Abs(repoFS.Root())
+	require.NoError(t, err)
+	repoURL := "file://" + repoPath
+


Signed-off-by: Ayman Bagabas <[email protected]>

pjbgf

Tiny nit on defer sess.Close(). Apart from that, please rebase it.

pjbgf

@aymanbagabas thanks for working on this. 🙇

aymanbagabas requested a review from pjbgf April 24, 2026 18:44

aymanbagabas force-pushed the archive-git branch from 3fd5170 to f9a4d62 Compare April 24, 2026 19:00

aymanbagabas commented Apr 24, 2026

View reviewed changes

aymanbagabas force-pushed the archive-git branch from f9a4d62 to 0183df3 Compare April 27, 2026 15:19

pjbgf requested changes May 6, 2026

View reviewed changes

Copilot AI review requested due to automatic review settings May 6, 2026 14:19

aymanbagabas force-pushed the archive-git branch from 0183df3 to 4ef6487 Compare May 6, 2026 14:19

Copilot started reviewing on behalf of aymanbagabas May 6, 2026 14:19 View session

Copilot AI reviewed May 6, 2026

View reviewed changes

aymanbagabas requested a review from pjbgf May 6, 2026 14:31

pjbgf mentioned this pull request May 6, 2026

Align object encoding with upstream #2066

Merged

aymanbagabas force-pushed the archive-git branch 2 times, most recently from 5924d14 to 9293937 Compare May 9, 2026 18:00

aymanbagabas requested a review from Copilot May 9, 2026 18:02

aymanbagabas force-pushed the archive-git branch from 9293937 to 4ee8db2 Compare May 9, 2026 18:02

Copilot started reviewing on behalf of aymanbagabas May 9, 2026 18:02 View session

aymanbagabas force-pushed the archive-git branch from 4ee8db2 to 6dea73c Compare May 9, 2026 18:02

Copilot AI reviewed May 9, 2026

View reviewed changes

Comment thread archive.go

Comment thread archive.go

Comment thread repository.go Outdated

Comment thread repository.go Outdated

Comment thread repository_test.go Outdated

Comment thread archive_test.go

Comment thread internal/archive/archive.go

aymanbagabas force-pushed the archive-git branch from 6dea73c to 57a94dc Compare May 9, 2026 18:23

aymanbagabas requested a review from Copilot May 9, 2026 18:23

Copilot started reviewing on behalf of aymanbagabas May 9, 2026 18:23 View session

aymanbagabas force-pushed the archive-git branch from 57a94dc to d8480cf Compare May 9, 2026 18:24

Copilot AI reviewed May 9, 2026

View reviewed changes

aymanbagabas force-pushed the archive-git branch 2 times, most recently from ff3e445 to c1dafd7 Compare May 9, 2026 18:34

aymanbagabas requested a review from Copilot May 9, 2026 18:34

Copilot started reviewing on behalf of aymanbagabas May 9, 2026 18:35 View session

Copilot AI reviewed May 9, 2026

View reviewed changes

aymanbagabas force-pushed the archive-git branch from c1dafd7 to 14c685e Compare May 9, 2026 18:45

git: add repository and remote archive support

104343e

Signed-off-by: Ayman Bagabas <[email protected]>

aymanbagabas force-pushed the archive-git branch from 14c685e to 104343e Compare May 9, 2026 18:47

pjbgf reviewed May 12, 2026

View reviewed changes

Comment thread archive.go

pjbgf reviewed May 12, 2026

View reviewed changes

pjbgf approved these changes May 13, 2026

View reviewed changes

pjbgf merged commit 5f8076d into go-git:main May 13, 2026
17 checks passed

Conversation

aymanbagabas commented Apr 24, 2026

Uh oh!

aymanbagabas Apr 24, 2026

Choose a reason for hiding this comment

Uh oh!

pjbgf left a comment

Choose a reason for hiding this comment

Uh oh!

pjbgf May 6, 2026

Choose a reason for hiding this comment

Uh oh!

aymanbagabas May 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aymanbagabas May 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Copilot's findings

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot's findings

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot's findings

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aymanbagabas May 9, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot's findings

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pjbgf left a comment

Choose a reason for hiding this comment

Uh oh!

pjbgf left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

aymanbagabas May 6, 2026 •

edited

Loading