Skip to content

Build: client side querystring resolution #23450

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+18 −0
Open

Build: client side querystring resolution #23450

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions content/manuals/build/concepts/context.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,24 @@ $ docker buildx build 'https://github.com/user/myrepo.git?tag=v0.1.0&commit=dead
> Short commit hash is supported with `checksum` (alias `commit`) query but for
> `ref`, only the full hash of the commit is supported.

##### Handling of URL queries

By default, Docker Buildx forwards query parameters to BuildKit.

For advanced scenarios, you can change this behavior with the environment variable
`BUILDX_SEND_GIT_QUERY_AS_INPUT`. Instead of just forwarding the query to BuildKit, Buildx itself creates a new “input” object for the Git context and injects it directly.

Example:

```console
# Default: queries are forwarded
$ docker buildx build 'https://github.com/user/myrepo.git?branch=dev&subdir=src'

# Alternative: tBuildx resolves the query and injects it as an input
BUILDX_SEND_GIT_QUERY_AS_INPUT=true \
docker buildx build 'https://github.com/user/myrepo.git?branch=dev&subdir=src'
```

#### Keep `.git` directory

By default, BuildKit doesn't keep the `.git` directory when using Git contexts.
Expand Down