From c74ca099cbed179d62f251399c801894b85000ce Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Wed, 15 Apr 2026 15:56:07 +0200 Subject: [PATCH 1/6] ci: add workflow to sync upstream CLI reference docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Pull-based workflow that runs in docker/docs — no cross-repo auth needed. Runs daily to auto-detect new releases, or manually via workflow_dispatch. For each configured upstream repo, runs the `docs-release` bake target via git context, copies YAML output to data/cli//, and opens a PR. Upstream contract: define a `docs-release` bake target that outputs *.yaml CLI reference files. Co-Authored-By: Claude Opus 4.6 (1M context) --- .github/workflows/sync-upstream-cli.yml | 211 ++++++++++++++++++++++++ 1 file changed, 211 insertions(+) create mode 100644 .github/workflows/sync-upstream-cli.yml diff --git a/.github/workflows/sync-upstream-cli.yml b/.github/workflows/sync-upstream-cli.yml new file mode 100644 index 00000000000..380adb77977 --- /dev/null +++ b/.github/workflows/sync-upstream-cli.yml @@ -0,0 +1,211 @@ +# Syncs CLI reference YAML from upstream repositories. +# +# Runs on a schedule to auto-detect new releases, or manually via workflow_dispatch. +# For each configured upstream repo, runs the `docs-release` bake target via git +# context to generate YAML, copies it to data/cli//, and opens a PR. +# +# Upstream contract: define a `docs-release` bake target that outputs YAML files +# to an `out/` directory. Example (in docker-bake.hcl): +# +# target "docs-release" { +# target = "docs-release" +# output = ["out"] +# } +# +# The Dockerfile stage should produce *.yaml CLI reference files in /out/. + +name: sync-upstream-cli + +on: + schedule: + # Check for new upstream releases daily at 02:00 UTC + - cron: "0 2 * * *" + workflow_dispatch: + inputs: + repo: + description: "Upstream repo (e.g., docker/buildx)" + required: true + type: choice + options: + - docker/buildx + - docker/compose + - docker/cli + - docker/model-runner + version: + description: "Git tag to sync (e.g., v0.33.0). Leave empty to use latest release." + required: false + type: string + +permissions: + contents: write + pull-requests: write + +# Each upstream repo and its corresponding data/cli/ subfolder. +# Add new entries here when onboarding a repo. +env: + SETUP_BUILDX_VERSION: "edge" + SETUP_BUILDKIT_IMAGE: "moby/buildkit:latest" + +jobs: + # Build the matrix of repos to sync. + # On workflow_dispatch: sync only the selected repo. + # On schedule: sync all configured repos. + prepare: + runs-on: ubuntu-24.04 + outputs: + matrix: ${{ steps.matrix.outputs.result }} + steps: + - name: Build matrix + id: matrix + uses: actions/github-script@v7 + with: + script: | + // Upstream repos and their data/cli/ subfolder + hugo.yaml version key + const repos = [ + { repo: "docker/buildx", folder: "buildx" }, + { repo: "docker/compose", folder: "compose" }, + { repo: "docker/cli", folder: "engine" }, + { repo: "docker/model-runner", folder: "model" }, + ]; + + const input_repo = context.payload.inputs?.repo || ""; + const input_version = context.payload.inputs?.version || ""; + + let matrix = []; + for (const r of repos) { + if (input_repo && r.repo !== input_repo) continue; + + // Get the version to sync + let version = input_version; + if (!version) { + // Fetch latest release from GitHub + try { + const { data: release } = await github.rest.repos.getLatestRelease({ + owner: r.repo.split("/")[0], + repo: r.repo.split("/")[1], + }); + version = release.tag_name; + } catch (e) { + core.warning(`Could not fetch latest release for ${r.repo}: ${e.message}`); + continue; + } + } + + matrix.push({ ...r, version }); + } + + core.info(JSON.stringify(matrix, null, 2)); + return matrix; + + sync: + needs: prepare + if: ${{ fromJSON(needs.prepare.outputs.matrix).length > 0 }} + runs-on: ubuntu-24.04 + strategy: + fail-fast: false + matrix: + include: ${{ fromJSON(needs.prepare.outputs.matrix) }} + env: + BRANCH: "bot/sync-${{ matrix.folder }}-cli" + steps: + - name: Checkout docker/docs + uses: actions/checkout@v5 + with: + fetch-depth: 0 + + - name: Check if already synced + id: check + run: | + # Check if a closed PR already exists for this version + EXISTING=$(gh pr list --state all \ + --search "cli(${{ matrix.folder }}): sync docs ${{ matrix.version }} in:title" \ + --json state,url --jq '.[0].state // empty') + + if [ "$EXISTING" = "MERGED" ] || [ "$EXISTING" = "CLOSED" ]; then + echo "skip=true" >> "$GITHUB_OUTPUT" + echo "Already synced ${{ matrix.repo }} ${{ matrix.version }}" >> "$GITHUB_STEP_SUMMARY" + else + echo "skip=false" >> "$GITHUB_OUTPUT" + fi + env: + GH_TOKEN: ${{ github.token }} + + - name: Set up Docker Buildx + if: steps.check.outputs.skip != 'true' + uses: docker/setup-buildx-action@v4 + with: + version: ${{ env.SETUP_BUILDX_VERSION }} + driver-opts: image=${{ env.SETUP_BUILDKIT_IMAGE }} + + - name: Generate YAML + if: steps.check.outputs.skip != 'true' + uses: docker/bake-action@v7 + with: + source: "${{ github.server_url }}/${{ matrix.repo }}.git#${{ matrix.version }}" + targets: docs-release + provenance: false + set: | + *.output=/tmp/docs-release + + - name: Copy data files + if: steps.check.outputs.skip != 'true' + run: | + mkdir -p "data/cli/${{ matrix.folder }}" + rm -f "data/cli/${{ matrix.folder }}"/*.yaml + cp /tmp/docs-release/out/*.yaml "data/cli/${{ matrix.folder }}/" + + - name: Check for changes + if: steps.check.outputs.skip != 'true' + id: diff + run: | + git add "data/cli/${{ matrix.folder }}/" + if git diff --cached --quiet; then + echo "changes=false" >> "$GITHUB_OUTPUT" + echo "No changes detected for ${{ matrix.repo }} ${{ matrix.version }}" >> "$GITHUB_STEP_SUMMARY" + else + echo "changes=true" >> "$GITHUB_OUTPUT" + echo '```' >> "$GITHUB_STEP_SUMMARY" + git diff --cached --stat >> "$GITHUB_STEP_SUMMARY" + echo '```' >> "$GITHUB_STEP_SUMMARY" + fi + + - name: Commit and push + if: steps.check.outputs.skip != 'true' && steps.diff.outputs.changes == 'true' + run: | + git config user.name "github-actions[bot]" + git config user.email "41898282+github-actions[bot]@users.noreply.github.com" + git checkout -b "$BRANCH" + git commit -m "cli(${{ matrix.folder }}): sync docs ${{ matrix.version }}" + git push -u origin "$BRANCH" --force + + - name: Create or update PR + if: steps.check.outputs.skip != 'true' && steps.diff.outputs.changes == 'true' + env: + GH_TOKEN: ${{ github.token }} + run: | + TITLE="cli(${{ matrix.folder }}): sync docs ${{ matrix.version }}" + + EXISTING=$(gh pr list --state open \ + --head "$BRANCH" --json url --jq '.[0].url // empty') + + BODY=$(cat <> "$GITHUB_STEP_SUMMARY" + git push -u origin "$BRANCH" --force + gh pr edit "$EXISTING" --title "$TITLE" --body "$BODY" + else + echo "Creating new PR" >> "$GITHUB_STEP_SUMMARY" + gh pr create --title "$TITLE" --base main --head "$BRANCH" --body "$BODY" + fi From c69d7b32641faddb2fcc4e07abd2a8c2b635d2a2 Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Wed, 15 Apr 2026 16:01:49 +0200 Subject: [PATCH 2/6] ci: add workflow to sync upstream CLI reference docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Pull-based workflow that runs in docker/docs — no cross-repo auth needed. Runs daily to auto-detect new releases, or manually via workflow_dispatch. Uses existing upstream bake targets via git context: - docker/buildx: `update-docs` target - docker/compose: `docs-update` target - docker/model-runner: `update-docs` target (cmd/cli/docker-bake.hcl) Generates YAML, copies to data/cli//, and opens a PR. Co-Authored-By: Claude Opus 4.6 (1M context) --- .github/workflows/sync-upstream-cli.yml | 77 ++++++++++++++----------- 1 file changed, 42 insertions(+), 35 deletions(-) diff --git a/.github/workflows/sync-upstream-cli.yml b/.github/workflows/sync-upstream-cli.yml index 380adb77977..09131b43521 100644 --- a/.github/workflows/sync-upstream-cli.yml +++ b/.github/workflows/sync-upstream-cli.yml @@ -1,18 +1,12 @@ # Syncs CLI reference YAML from upstream repositories. # # Runs on a schedule to auto-detect new releases, or manually via workflow_dispatch. -# For each configured upstream repo, runs the `docs-release` bake target via git -# context to generate YAML, copies it to data/cli//, and opens a PR. +# For each configured upstream repo, runs its docs bake target via git context +# to generate YAML, copies it to data/cli//, and opens a PR. # -# Upstream contract: define a `docs-release` bake target that outputs YAML files -# to an `out/` directory. Example (in docker-bake.hcl): -# -# target "docs-release" { -# target = "docs-release" -# output = ["out"] -# } -# -# The Dockerfile stage should produce *.yaml CLI reference files in /out/. +# Upstream contract: a bake target that outputs *.yaml CLI reference files. +# Target names and output paths are configured per-repo in the `repos` array below. +# Long-term goal: standardize on a common `docs-release` target name across repos. name: sync-upstream-cli @@ -29,7 +23,6 @@ on: options: - docker/buildx - docker/compose - - docker/cli - docker/model-runner version: description: "Git tag to sync (e.g., v0.33.0). Leave empty to use latest release." @@ -40,16 +33,11 @@ permissions: contents: write pull-requests: write -# Each upstream repo and its corresponding data/cli/ subfolder. -# Add new entries here when onboarding a repo. env: SETUP_BUILDX_VERSION: "edge" SETUP_BUILDKIT_IMAGE: "moby/buildkit:latest" jobs: - # Build the matrix of repos to sync. - # On workflow_dispatch: sync only the selected repo. - # On schedule: sync all configured repos. prepare: runs-on: ubuntu-24.04 outputs: @@ -60,25 +48,43 @@ jobs: uses: actions/github-script@v7 with: script: | - // Upstream repos and their data/cli/ subfolder + hugo.yaml version key + // Each upstream repo with its bake configuration. + // - target: the bake target name that generates CLI YAML + // - files: bake file path (empty = root docker-bake.hcl) + // - yaml_glob: where the YAML ends up in the bake output const repos = [ - { repo: "docker/buildx", folder: "buildx" }, - { repo: "docker/compose", folder: "compose" }, - { repo: "docker/cli", folder: "engine" }, - { repo: "docker/model-runner", folder: "model" }, + { + repo: "docker/buildx", + folder: "buildx", + target: "update-docs", + files: "", + yaml_glob: "out/reference", + }, + { + repo: "docker/compose", + folder: "compose", + target: "docs-update", + files: "", + yaml_glob: "out/reference", + }, + { + repo: "docker/model-runner", + folder: "model", + target: "update-docs", + files: "cmd/cli/docker-bake.hcl", + yaml_glob: ".", + }, ]; - const input_repo = context.payload.inputs?.repo || ""; - const input_version = context.payload.inputs?.version || ""; + const inputRepo = context.payload.inputs?.repo || ""; + const inputVersion = context.payload.inputs?.version || ""; let matrix = []; for (const r of repos) { - if (input_repo && r.repo !== input_repo) continue; + if (inputRepo && r.repo !== inputRepo) continue; - // Get the version to sync - let version = input_version; + let version = inputVersion; if (!version) { - // Fetch latest release from GitHub try { const { data: release } = await github.rest.repos.getLatestRelease({ owner: r.repo.split("/")[0], @@ -115,11 +121,12 @@ jobs: - name: Check if already synced id: check + env: + GH_TOKEN: ${{ github.token }} run: | - # Check if a closed PR already exists for this version EXISTING=$(gh pr list --state all \ --search "cli(${{ matrix.folder }}): sync docs ${{ matrix.version }} in:title" \ - --json state,url --jq '.[0].state // empty') + --json state --jq '.[0].state // empty') if [ "$EXISTING" = "MERGED" ] || [ "$EXISTING" = "CLOSED" ]; then echo "skip=true" >> "$GITHUB_OUTPUT" @@ -127,8 +134,6 @@ jobs: else echo "skip=false" >> "$GITHUB_OUTPUT" fi - env: - GH_TOKEN: ${{ github.token }} - name: Set up Docker Buildx if: steps.check.outputs.skip != 'true' @@ -142,17 +147,20 @@ jobs: uses: docker/bake-action@v7 with: source: "${{ github.server_url }}/${{ matrix.repo }}.git#${{ matrix.version }}" - targets: docs-release + files: ${{ matrix.files || '' }} + targets: ${{ matrix.target }} provenance: false set: | *.output=/tmp/docs-release + env: + DOCS_FORMATS: yaml - name: Copy data files if: steps.check.outputs.skip != 'true' run: | mkdir -p "data/cli/${{ matrix.folder }}" rm -f "data/cli/${{ matrix.folder }}"/*.yaml - cp /tmp/docs-release/out/*.yaml "data/cli/${{ matrix.folder }}/" + cp /tmp/docs-release/${{ matrix.yaml_glob }}/*.yaml "data/cli/${{ matrix.folder }}/" - name: Check for changes if: steps.check.outputs.skip != 'true' @@ -203,7 +211,6 @@ jobs: if [ -n "$EXISTING" ]; then echo "Updating existing PR: $EXISTING" >> "$GITHUB_STEP_SUMMARY" - git push -u origin "$BRANCH" --force gh pr edit "$EXISTING" --title "$TITLE" --body "$BODY" else echo "Creating new PR" >> "$GITHUB_STEP_SUMMARY" From 8cc3b5fce1a5629005bb1b44d4a8bf6c66480099 Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Wed, 15 Apr 2026 16:10:34 +0200 Subject: [PATCH 3/6] ci: move compose and model-runner CLI YAML out of Hugo modules Move CLI reference YAML for compose and model-runner from Hugo module mounts (_vendor/) to data/cli/, where it will be managed by the sync-upstream-cli workflow alongside buildx and engine. - Copy YAML from _vendor/ to data/cli/compose/ and data/cli/model/ - Remove compose and model-runner imports from hugo.yaml - Remove from go.mod, go.sum, and _vendor/modules.txt Co-Authored-By: Claude Opus 4.6 (1M context) --- .../compose/v5/docs/reference/compose.md | 264 ------------------ .../v5/docs/reference/compose_alpha.md | 22 -- .../docs/reference/compose_alpha_dry-run.md | 8 - .../docs/reference/compose_alpha_generate.md | 17 -- .../docs/reference/compose_alpha_publish.md | 18 -- .../v5/docs/reference/compose_alpha_scale.md | 15 - .../v5/docs/reference/compose_alpha_viz.md | 19 -- .../v5/docs/reference/compose_alpha_watch.md | 16 -- .../v5/docs/reference/compose_attach.md | 17 -- .../v5/docs/reference/compose_bridge.md | 22 -- .../docs/reference/compose_bridge_convert.md | 17 -- .../compose_bridge_transformations.md | 22 -- .../compose_bridge_transformations_create.md | 15 - .../compose_bridge_transformations_list.md | 20 -- .../v5/docs/reference/compose_build.md | 46 --- .../v5/docs/reference/compose_commit.md | 19 -- .../v5/docs/reference/compose_config.md | 40 --- .../compose/v5/docs/reference/compose_cp.md | 18 -- .../v5/docs/reference/compose_create.md | 23 -- .../compose/v5/docs/reference/compose_down.md | 45 --- .../v5/docs/reference/compose_events.md | 56 ---- .../compose/v5/docs/reference/compose_exec.md | 42 --- .../v5/docs/reference/compose_export.md | 16 -- .../v5/docs/reference/compose_images.md | 16 -- .../compose/v5/docs/reference/compose_kill.md | 27 -- .../compose/v5/docs/reference/compose_logs.md | 25 -- .../compose/v5/docs/reference/compose_ls.md | 21 -- .../v5/docs/reference/compose_pause.md | 17 -- .../compose/v5/docs/reference/compose_port.md | 19 -- .../compose/v5/docs/reference/compose_ps.md | 138 --------- .../v5/docs/reference/compose_publish.md | 19 -- .../compose/v5/docs/reference/compose_pull.md | 68 ----- .../compose/v5/docs/reference/compose_push.md | 54 ---- .../v5/docs/reference/compose_restart.md | 37 --- .../compose/v5/docs/reference/compose_rm.md | 48 ---- .../compose/v5/docs/reference/compose_run.md | 145 ---------- .../v5/docs/reference/compose_scale.md | 15 - .../v5/docs/reference/compose_start.md | 19 -- .../v5/docs/reference/compose_stats.md | 18 -- .../compose/v5/docs/reference/compose_stop.md | 18 -- .../compose/v5/docs/reference/compose_top.md | 26 -- .../v5/docs/reference/compose_unpause.md | 17 -- .../compose/v5/docs/reference/compose_up.md | 82 ------ .../v5/docs/reference/compose_version.md | 15 - .../v5/docs/reference/compose_volumes.md | 16 -- .../compose/v5/docs/reference/compose_wait.md | 15 - .../v5/docs/reference/compose_watch.md | 17 -- .../cmd/cli/docs/reference/model.md | 45 --- .../cmd/cli/docs/reference/model_bench.md | 21 -- .../cmd/cli/docs/reference/model_configure.md | 14 - .../cmd/cli/docs/reference/model_df.md | 8 - .../cmd/cli/docs/reference/model_inspect.md | 15 - .../docs/reference/model_install-runner.md | 27 -- .../cmd/cli/docs/reference/model_launch.md | 30 -- .../cmd/cli/docs/reference/model_list.md | 21 -- .../cmd/cli/docs/reference/model_logs.md | 15 - .../cmd/cli/docs/reference/model_package.md | 59 ---- .../cmd/cli/docs/reference/model_ps.md | 8 - .../cmd/cli/docs/reference/model_pull.md | 32 --- .../cmd/cli/docs/reference/model_purge.md | 14 - .../cmd/cli/docs/reference/model_push.md | 13 - .../docs/reference/model_reinstall-runner.md | 27 -- .../cmd/cli/docs/reference/model_requests.md | 16 -- .../docs/reference/model_restart-runner.md | 24 -- .../cmd/cli/docs/reference/model_rm.md | 14 - .../cmd/cli/docs/reference/model_run.md | 61 ---- .../cmd/cli/docs/reference/model_search.md | 27 -- .../cmd/cli/docs/reference/model_show.md | 14 - .../cmd/cli/docs/reference/model_skills.md | 32 --- .../cli/docs/reference/model_start-runner.md | 29 -- .../cmd/cli/docs/reference/model_status.md | 17 -- .../cli/docs/reference/model_stop-runner.md | 19 -- .../cmd/cli/docs/reference/model_tag.md | 11 - .../docs/reference/model_uninstall-runner.md | 16 -- .../cmd/cli/docs/reference/model_unload.md | 15 - .../cmd/cli/docs/reference/model_version.md | 8 - _vendor/modules.txt | 2 - .../cli/compose}/docker_compose.yaml | 0 .../cli/compose}/docker_compose_alpha.yaml | 0 .../docker_compose_alpha_dry-run.yaml | 0 .../docker_compose_alpha_generate.yaml | 0 .../docker_compose_alpha_publish.yaml | 0 .../compose}/docker_compose_alpha_scale.yaml | 0 .../compose}/docker_compose_alpha_viz.yaml | 0 .../compose}/docker_compose_alpha_watch.yaml | 0 .../cli/compose}/docker_compose_attach.yaml | 0 .../cli/compose}/docker_compose_bridge.yaml | 0 .../docker_compose_bridge_convert.yaml | 0 ...docker_compose_bridge_transformations.yaml | 0 ...compose_bridge_transformations_create.yaml | 0 ...r_compose_bridge_transformations_list.yaml | 0 .../cli/compose}/docker_compose_build.yaml | 0 .../cli/compose}/docker_compose_commit.yaml | 0 .../cli/compose}/docker_compose_config.yaml | 0 .../cli/compose}/docker_compose_convert.yaml | 0 .../cli/compose}/docker_compose_cp.yaml | 0 .../cli/compose}/docker_compose_create.yaml | 0 .../cli/compose}/docker_compose_down.yaml | 0 .../cli/compose}/docker_compose_events.yaml | 0 .../cli/compose}/docker_compose_exec.yaml | 0 .../cli/compose}/docker_compose_export.yaml | 0 .../cli/compose}/docker_compose_images.yaml | 0 .../cli/compose}/docker_compose_kill.yaml | 0 .../cli/compose}/docker_compose_logs.yaml | 0 .../cli/compose}/docker_compose_ls.yaml | 0 .../cli/compose}/docker_compose_pause.yaml | 0 .../cli/compose}/docker_compose_port.yaml | 0 .../cli/compose}/docker_compose_ps.yaml | 0 .../cli/compose}/docker_compose_publish.yaml | 0 .../cli/compose}/docker_compose_pull.yaml | 0 .../cli/compose}/docker_compose_push.yaml | 0 .../cli/compose}/docker_compose_restart.yaml | 0 .../cli/compose}/docker_compose_rm.yaml | 0 .../cli/compose}/docker_compose_run.yaml | 0 .../cli/compose}/docker_compose_scale.yaml | 0 .../cli/compose}/docker_compose_start.yaml | 0 .../cli/compose}/docker_compose_stats.yaml | 0 .../cli/compose}/docker_compose_stop.yaml | 0 .../cli/compose}/docker_compose_top.yaml | 0 .../cli/compose}/docker_compose_unpause.yaml | 0 .../cli/compose}/docker_compose_up.yaml | 0 .../cli/compose}/docker_compose_version.yaml | 0 .../cli/compose}/docker_compose_volumes.yaml | 0 .../cli/compose}/docker_compose_wait.yaml | 0 .../cli/compose}/docker_compose_watch.yaml | 0 .../cli/model}/docker_model.yaml | 0 .../cli/model}/docker_model_bench.yaml | 0 .../cli/model}/docker_model_compose.yaml | 0 .../cli/model}/docker_model_compose_down.yaml | 0 .../model}/docker_model_compose_metadata.yaml | 0 .../cli/model}/docker_model_compose_up.yaml | 0 .../cli/model}/docker_model_configure.yaml | 0 .../model}/docker_model_configure_show.yaml | 0 .../cli/model}/docker_model_df.yaml | 0 .../cli/model}/docker_model_inspect.yaml | 0 .../model}/docker_model_install-runner.yaml | 0 .../cli/model}/docker_model_launch.yaml | 0 .../cli/model}/docker_model_list.yaml | 0 .../cli/model}/docker_model_logs.yaml | 0 .../cli/model}/docker_model_package.yaml | 0 .../cli/model}/docker_model_ps.yaml | 0 .../cli/model}/docker_model_pull.yaml | 0 .../cli/model}/docker_model_purge.yaml | 0 .../cli/model}/docker_model_push.yaml | 0 .../model}/docker_model_reinstall-runner.yaml | 0 .../cli/model}/docker_model_requests.yaml | 0 .../model}/docker_model_restart-runner.yaml | 0 .../cli/model}/docker_model_rm.yaml | 0 .../cli/model}/docker_model_run.yaml | 0 .../cli/model}/docker_model_search.yaml | 0 .../cli/model}/docker_model_show.yaml | 0 .../cli/model}/docker_model_skills.yaml | 0 .../cli/model}/docker_model_start-runner.yaml | 0 .../cli/model}/docker_model_status.yaml | 0 .../cli/model}/docker_model_stop-runner.yaml | 0 .../cli/model}/docker_model_tag.yaml | 0 .../model}/docker_model_uninstall-runner.yaml | 0 .../cli/model}/docker_model_unload.yaml | 0 .../cli/model}/docker_model_version.yaml | 0 go.mod | 4 - go.sum | 22 -- hugo.yaml | 15 +- 162 files changed, 2 insertions(+), 2382 deletions(-) delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_alpha.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_alpha_dry-run.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_alpha_generate.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_alpha_publish.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_alpha_scale.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_alpha_viz.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_alpha_watch.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_attach.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_bridge.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_bridge_convert.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_bridge_transformations.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_bridge_transformations_create.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_bridge_transformations_list.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_build.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_commit.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_config.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_cp.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_create.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_down.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_events.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_exec.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_export.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_images.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_kill.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_logs.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_ls.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_pause.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_port.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_ps.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_publish.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_pull.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_push.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_restart.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_rm.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_run.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_scale.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_start.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_stats.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_stop.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_top.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_unpause.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_up.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_version.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_volumes.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_wait.md delete mode 100644 _vendor/github.com/docker/compose/v5/docs/reference/compose_watch.md delete mode 100644 _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model.md delete mode 100644 _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_bench.md delete mode 100644 _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_configure.md delete mode 100644 _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_df.md delete mode 100644 _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_inspect.md delete mode 100644 _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_install-runner.md delete mode 100644 _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_launch.md delete mode 100644 _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_list.md delete mode 100644 _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_logs.md delete mode 100644 _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_package.md delete mode 100644 _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_ps.md delete mode 100644 _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_pull.md delete mode 100644 _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_purge.md delete mode 100644 _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_push.md delete mode 100644 _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_reinstall-runner.md delete mode 100644 _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_requests.md delete mode 100644 _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_restart-runner.md delete mode 100644 _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_rm.md delete mode 100644 _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_run.md delete mode 100644 _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_search.md delete mode 100644 _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_show.md delete mode 100644 _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_skills.md delete mode 100644 _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_start-runner.md delete mode 100644 _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_status.md delete mode 100644 _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_stop-runner.md delete mode 100644 _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_tag.md delete mode 100644 _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_uninstall-runner.md delete mode 100644 _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_unload.md delete mode 100644 _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_version.md rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_alpha.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_alpha_dry-run.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_alpha_generate.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_alpha_publish.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_alpha_scale.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_alpha_viz.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_alpha_watch.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_attach.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_bridge.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_bridge_convert.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_bridge_transformations.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_bridge_transformations_create.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_bridge_transformations_list.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_build.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_commit.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_config.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_convert.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_cp.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_create.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_down.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_events.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_exec.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_export.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_images.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_kill.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_logs.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_ls.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_pause.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_port.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_ps.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_publish.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_pull.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_push.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_restart.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_rm.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_run.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_scale.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_start.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_stats.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_stop.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_top.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_unpause.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_up.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_version.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_volumes.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_wait.yaml (100%) rename {_vendor/github.com/docker/compose/v5/docs/reference => data/cli/compose}/docker_compose_watch.yaml (100%) rename {_vendor/github.com/docker/model-runner/cmd/cli/docs/reference => data/cli/model}/docker_model.yaml (100%) rename {_vendor/github.com/docker/model-runner/cmd/cli/docs/reference => data/cli/model}/docker_model_bench.yaml (100%) rename {_vendor/github.com/docker/model-runner/cmd/cli/docs/reference => data/cli/model}/docker_model_compose.yaml (100%) rename {_vendor/github.com/docker/model-runner/cmd/cli/docs/reference => data/cli/model}/docker_model_compose_down.yaml (100%) rename {_vendor/github.com/docker/model-runner/cmd/cli/docs/reference => data/cli/model}/docker_model_compose_metadata.yaml (100%) rename {_vendor/github.com/docker/model-runner/cmd/cli/docs/reference => data/cli/model}/docker_model_compose_up.yaml (100%) rename {_vendor/github.com/docker/model-runner/cmd/cli/docs/reference => data/cli/model}/docker_model_configure.yaml (100%) rename {_vendor/github.com/docker/model-runner/cmd/cli/docs/reference => data/cli/model}/docker_model_configure_show.yaml (100%) rename {_vendor/github.com/docker/model-runner/cmd/cli/docs/reference => data/cli/model}/docker_model_df.yaml (100%) rename {_vendor/github.com/docker/model-runner/cmd/cli/docs/reference => data/cli/model}/docker_model_inspect.yaml (100%) rename {_vendor/github.com/docker/model-runner/cmd/cli/docs/reference => data/cli/model}/docker_model_install-runner.yaml (100%) rename {_vendor/github.com/docker/model-runner/cmd/cli/docs/reference => data/cli/model}/docker_model_launch.yaml (100%) rename {_vendor/github.com/docker/model-runner/cmd/cli/docs/reference => data/cli/model}/docker_model_list.yaml (100%) rename {_vendor/github.com/docker/model-runner/cmd/cli/docs/reference => data/cli/model}/docker_model_logs.yaml (100%) rename {_vendor/github.com/docker/model-runner/cmd/cli/docs/reference => data/cli/model}/docker_model_package.yaml (100%) rename {_vendor/github.com/docker/model-runner/cmd/cli/docs/reference => data/cli/model}/docker_model_ps.yaml (100%) rename {_vendor/github.com/docker/model-runner/cmd/cli/docs/reference => data/cli/model}/docker_model_pull.yaml (100%) rename {_vendor/github.com/docker/model-runner/cmd/cli/docs/reference => data/cli/model}/docker_model_purge.yaml (100%) rename {_vendor/github.com/docker/model-runner/cmd/cli/docs/reference => data/cli/model}/docker_model_push.yaml (100%) rename {_vendor/github.com/docker/model-runner/cmd/cli/docs/reference => data/cli/model}/docker_model_reinstall-runner.yaml (100%) rename {_vendor/github.com/docker/model-runner/cmd/cli/docs/reference => data/cli/model}/docker_model_requests.yaml (100%) rename {_vendor/github.com/docker/model-runner/cmd/cli/docs/reference => data/cli/model}/docker_model_restart-runner.yaml (100%) rename {_vendor/github.com/docker/model-runner/cmd/cli/docs/reference => data/cli/model}/docker_model_rm.yaml (100%) rename {_vendor/github.com/docker/model-runner/cmd/cli/docs/reference => data/cli/model}/docker_model_run.yaml (100%) rename {_vendor/github.com/docker/model-runner/cmd/cli/docs/reference => data/cli/model}/docker_model_search.yaml (100%) rename {_vendor/github.com/docker/model-runner/cmd/cli/docs/reference => data/cli/model}/docker_model_show.yaml (100%) rename {_vendor/github.com/docker/model-runner/cmd/cli/docs/reference => data/cli/model}/docker_model_skills.yaml (100%) rename {_vendor/github.com/docker/model-runner/cmd/cli/docs/reference => data/cli/model}/docker_model_start-runner.yaml (100%) rename {_vendor/github.com/docker/model-runner/cmd/cli/docs/reference => data/cli/model}/docker_model_status.yaml (100%) rename {_vendor/github.com/docker/model-runner/cmd/cli/docs/reference => data/cli/model}/docker_model_stop-runner.yaml (100%) rename {_vendor/github.com/docker/model-runner/cmd/cli/docs/reference => data/cli/model}/docker_model_tag.yaml (100%) rename {_vendor/github.com/docker/model-runner/cmd/cli/docs/reference => data/cli/model}/docker_model_uninstall-runner.yaml (100%) rename {_vendor/github.com/docker/model-runner/cmd/cli/docs/reference => data/cli/model}/docker_model_unload.yaml (100%) rename {_vendor/github.com/docker/model-runner/cmd/cli/docs/reference => data/cli/model}/docker_model_version.yaml (100%) diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose.md deleted file mode 100644 index d80bb86ec62..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose.md +++ /dev/null @@ -1,264 +0,0 @@ - -# docker compose - -```text -docker compose [-f ...] [options] [COMMAND] [ARGS...] -``` - - -Define and run multi-container applications with Docker - -### Subcommands - -| Name | Description | -|:--------------------------------|:----------------------------------------------------------------------------------------| -| [`attach`](compose_attach.md) | Attach local standard input, output, and error streams to a service's running container | -| [`bridge`](compose_bridge.md) | Convert compose files into another model | -| [`build`](compose_build.md) | Build or rebuild services | -| [`commit`](compose_commit.md) | Create a new image from a service container's changes | -| [`config`](compose_config.md) | Parse, resolve and render compose file in canonical format | -| [`cp`](compose_cp.md) | Copy files/folders between a service container and the local filesystem | -| [`create`](compose_create.md) | Creates containers for a service | -| [`down`](compose_down.md) | Stop and remove containers, networks | -| [`events`](compose_events.md) | Receive real time events from containers | -| [`exec`](compose_exec.md) | Execute a command in a running container | -| [`export`](compose_export.md) | Export a service container's filesystem as a tar archive | -| [`images`](compose_images.md) | List images used by the created containers | -| [`kill`](compose_kill.md) | Force stop service containers | -| [`logs`](compose_logs.md) | View output from containers | -| [`ls`](compose_ls.md) | List running compose projects | -| [`pause`](compose_pause.md) | Pause services | -| [`port`](compose_port.md) | Print the public port for a port binding | -| [`ps`](compose_ps.md) | List containers | -| [`publish`](compose_publish.md) | Publish compose application | -| [`pull`](compose_pull.md) | Pull service images | -| [`push`](compose_push.md) | Push service images | -| [`restart`](compose_restart.md) | Restart service containers | -| [`rm`](compose_rm.md) | Removes stopped service containers | -| [`run`](compose_run.md) | Run a one-off command on a service | -| [`scale`](compose_scale.md) | Scale services | -| [`start`](compose_start.md) | Start services | -| [`stats`](compose_stats.md) | Display a live stream of container(s) resource usage statistics | -| [`stop`](compose_stop.md) | Stop services | -| [`top`](compose_top.md) | Display the running processes | -| [`unpause`](compose_unpause.md) | Unpause services | -| [`up`](compose_up.md) | Create and start containers | -| [`version`](compose_version.md) | Show the Docker Compose version information | -| [`volumes`](compose_volumes.md) | List volumes | -| [`wait`](compose_wait.md) | Block until containers of all (or specified) services stop. | -| [`watch`](compose_watch.md) | Watch build context for service and rebuild/refresh containers when files are updated | - - -### Options - -| Name | Type | Default | Description | -|:-----------------------|:--------------|:--------|:----------------------------------------------------------------------------------------------------| -| `--all-resources` | `bool` | | Include all resources, even those not used by services | -| `--ansi` | `string` | `auto` | Control when to print ANSI control characters ("never"\|"always"\|"auto") | -| `--compatibility` | `bool` | | Run compose in backward compatibility mode | -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `--env-file` | `stringArray` | | Specify an alternate environment file | -| `-f`, `--file` | `stringArray` | | Compose configuration files | -| `--parallel` | `int` | `-1` | Control max parallelism, -1 for unlimited | -| `--profile` | `stringArray` | | Specify a profile to enable | -| `--progress` | `string` | | Set type of progress output (auto, tty, plain, json, quiet) | -| `--project-directory` | `string` | | Specify an alternate working directory
(default: the path of the, first specified, Compose file) | -| `-p`, `--project-name` | `string` | | Project name | - - - - -## Examples - -### Use `-f` to specify the name and path of one or more Compose files -Use the `-f` flag to specify the location of a Compose [configuration file](/reference/compose-file/). - -#### Specifying multiple Compose files -You can supply multiple `-f` configuration files. When you supply multiple files, Compose combines them into a single -configuration. Compose builds the configuration in the order you supply the files. Subsequent files override and add -to their predecessors. - -For example, consider this command line: - -```console -$ docker compose -f compose.yaml -f compose.admin.yaml run backup_db -``` - -The `compose.yaml` file might specify a `webapp` service. - -```yaml -services: - webapp: - image: examples/web - ports: - - "8000:8000" - volumes: - - "/data" -``` -If the `compose.admin.yaml` also specifies this same service, any matching fields override the previous file. -New values, add to the `webapp` service configuration. - -```yaml -services: - webapp: - build: . - environment: - - DEBUG=1 -``` - -When you use multiple Compose files, all paths in the files are relative to the first configuration file specified -with `-f`. You can use the `--project-directory` option to override this base path. - -Use a `-f` with `-` (dash) as the filename to read the configuration from stdin. When stdin is used all paths in the -configuration are relative to the current working directory. - -The `-f` flag is optional. If you don’t provide this flag on the command line, Compose traverses the working directory -and its parent directories looking for a `compose.yaml` or `docker-compose.yaml` file. - -#### Specifying a path to a single Compose file -You can use the `-f` flag to specify a path to a Compose file that is not located in the current directory, either -from the command line or by setting up a `COMPOSE_FILE` environment variable in your shell or in an environment file. - -For an example of using the `-f` option at the command line, suppose you are running the Compose Rails sample, and -have a `compose.yaml` file in a directory called `sandbox/rails`. You can use a command like `docker compose pull` to -get the postgres image for the db service from anywhere by using the `-f` flag as follows: - -```console -$ docker compose -f ~/sandbox/rails/compose.yaml pull db -``` - -#### Using an OCI published artifact -You can use the `-f` flag with the `oci://` prefix to reference a Compose file that has been published to an OCI registry. -This allows you to distribute and version your Compose configurations as OCI artifacts. - -To use a Compose file from an OCI registry: - -```console -$ docker compose -f oci://registry.example.com/my-compose-project:latest up -``` - -You can also combine OCI artifacts with local files: - -```console -$ docker compose -f oci://registry.example.com/my-compose-project:v1.0 -f compose.override.yaml up -``` - -The OCI artifact must contain a valid Compose file. You can publish Compose files to an OCI registry using the -`docker compose publish` command. - -#### Using a git repository -You can use the `-f` flag to reference a Compose file from a git repository. Compose supports various git URL formats: - -Using HTTPS: -```console -$ docker compose -f https://github.com/user/repo.git up -``` - -Using SSH: -```console -$ docker compose -f git@github.com:user/repo.git up -``` - -You can specify a specific branch, tag, or commit: -```console -$ docker compose -f https://github.com/user/repo.git@main up -$ docker compose -f https://github.com/user/repo.git@v1.0.0 up -$ docker compose -f https://github.com/user/repo.git@abc123 up -``` - -You can also specify a subdirectory within the repository: -```console -$ docker compose -f https://github.com/user/repo.git#main:path/to/compose.yaml up -``` - -When using git resources, Compose will clone the repository and use the specified Compose file. You can combine -git resources with local files: - -```console -$ docker compose -f https://github.com/user/repo.git -f compose.override.yaml up -``` - -### Use `-p` to specify a project name - -Each configuration has a project name. Compose sets the project name using -the following mechanisms, in order of precedence: -- The `-p` command line flag -- The `COMPOSE_PROJECT_NAME` environment variable -- The top level `name:` variable from the config file (or the last `name:` -from a series of config files specified using `-f`) -- The `basename` of the project directory containing the config file (or -containing the first config file specified using `-f`) -- The `basename` of the current directory if no config file is specified -Project names must contain only lowercase letters, decimal digits, dashes, -and underscores, and must begin with a lowercase letter or decimal digit. If -the `basename` of the project directory or current directory violates this -constraint, you must use one of the other mechanisms. - -```console -$ docker compose -p my_project ps -a -NAME SERVICE STATUS PORTS -my_project_demo_1 demo running - -$ docker compose -p my_project logs -demo_1 | PING localhost (127.0.0.1): 56 data bytes -demo_1 | 64 bytes from 127.0.0.1: seq=0 ttl=64 time=0.095 ms -``` - -### Use profiles to enable optional services - -Use `--profile` to specify one or more active profiles -Calling `docker compose --profile frontend up` starts the services with the profile `frontend` and services -without any specified profiles. -You can also enable multiple profiles, e.g. with `docker compose --profile frontend --profile debug up` the profiles `frontend` and `debug` is enabled. - -Profiles can also be set by `COMPOSE_PROFILES` environment variable. - -### Configuring parallelism - -Use `--parallel` to specify the maximum level of parallelism for concurrent engine calls. -Calling `docker compose --parallel 1 pull` pulls the pullable images defined in the Compose file -one at a time. This can also be used to control build concurrency. - -Parallelism can also be set by the `COMPOSE_PARALLEL_LIMIT` environment variable. - -### Set up environment variables - -You can set environment variables for various docker compose options, including the `-f`, `-p` and `--profiles` flags. - -Setting the `COMPOSE_FILE` environment variable is equivalent to passing the `-f` flag, -`COMPOSE_PROJECT_NAME` environment variable does the same as the `-p` flag, -`COMPOSE_PROFILES` environment variable is equivalent to the `--profiles` flag -and `COMPOSE_PARALLEL_LIMIT` does the same as the `--parallel` flag. - -If flags are explicitly set on the command line, the associated environment variable is ignored. - -Setting the `COMPOSE_IGNORE_ORPHANS` environment variable to `true` stops docker compose from detecting orphaned -containers for the project. - -Setting the `COMPOSE_MENU` environment variable to `false` disables the helper menu when running `docker compose up` -in attached mode. Alternatively, you can also run `docker compose up --menu=false` to disable the helper menu. - -### Use Dry Run mode to test your command - -Use `--dry-run` flag to test a command without changing your application stack state. -Dry Run mode shows you all the steps Compose applies when executing a command, for example: -```console -$ docker compose --dry-run up --build -d -[+] Pulling 1/1 - ✔ DRY-RUN MODE - db Pulled 0.9s -[+] Running 10/8 - ✔ DRY-RUN MODE - build service backend 0.0s - ✔ DRY-RUN MODE - ==> ==> writing image dryRun-754a08ddf8bcb1cf22f310f09206dd783d42f7dd 0.0s - ✔ DRY-RUN MODE - ==> ==> naming to nginx-golang-mysql-backend 0.0s - ✔ DRY-RUN MODE - Network nginx-golang-mysql_default Created 0.0s - ✔ DRY-RUN MODE - Container nginx-golang-mysql-db-1 Created 0.0s - ✔ DRY-RUN MODE - Container nginx-golang-mysql-backend-1 Created 0.0s - ✔ DRY-RUN MODE - Container nginx-golang-mysql-proxy-1 Created 0.0s - ✔ DRY-RUN MODE - Container nginx-golang-mysql-db-1 Healthy 0.5s - ✔ DRY-RUN MODE - Container nginx-golang-mysql-backend-1 Started 0.0s - ✔ DRY-RUN MODE - Container nginx-golang-mysql-proxy-1 Started Started -``` -From the example above, you can see that the first step is to pull the image defined by `db` service, then build the `backend` service. -Next, the containers are created. The `db` service is started, and the `backend` and `proxy` wait until the `db` service is healthy before starting. - -Dry Run mode works with almost all commands. You cannot use Dry Run mode with a command that doesn't change the state of a Compose stack such as `ps`, `ls`, `logs` for example. diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_alpha.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_alpha.md deleted file mode 100644 index 34485d7deff..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_alpha.md +++ /dev/null @@ -1,22 +0,0 @@ -# docker compose alpha - - -Experimental commands - -### Subcommands - -| Name | Description | -|:----------------------------------|:-----------------------------------------------------------------------------------------------------| -| [`viz`](compose_alpha_viz.md) | EXPERIMENTAL - Generate a graphviz graph from your compose file | -| [`watch`](compose_alpha_watch.md) | EXPERIMENTAL - Watch build context for service and rebuild/refresh containers when files are updated | - - -### Options - -| Name | Type | Default | Description | -|:------------|:-----|:--------|:--------------------------------| -| `--dry-run` | | | Execute command in dry run mode | - - - - diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_alpha_dry-run.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_alpha_dry-run.md deleted file mode 100644 index 7c68d94d66b..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_alpha_dry-run.md +++ /dev/null @@ -1,8 +0,0 @@ -# docker compose alpha dry-run - - -Dry run command allows you to test a command without applying changes - - - - diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_alpha_generate.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_alpha_generate.md deleted file mode 100644 index f4054627798..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_alpha_generate.md +++ /dev/null @@ -1,17 +0,0 @@ -# docker compose alpha generate - - -EXPERIMENTAL - Generate a Compose file from existing containers - -### Options - -| Name | Type | Default | Description | -|:----------------|:---------|:--------|:------------------------------------------| -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `--format` | `string` | `yaml` | Format the output. Values: [yaml \| json] | -| `--name` | `string` | | Project name to set in the Compose file | -| `--project-dir` | `string` | | Directory to use for the project | - - - - diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_alpha_publish.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_alpha_publish.md deleted file mode 100644 index 6e77d714532..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_alpha_publish.md +++ /dev/null @@ -1,18 +0,0 @@ -# docker compose alpha publish - - -Publish compose application - -### Options - -| Name | Type | Default | Description | -|:--------------------------|:---------|:--------|:-------------------------------------------------------------------------------| -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `--oci-version` | `string` | | OCI image/artifact specification version (automatically determined by default) | -| `--resolve-image-digests` | `bool` | | Pin image tags to digests | -| `--with-env` | `bool` | | Include environment variables in the published OCI artifact | -| `-y`, `--yes` | `bool` | | Assume "yes" as answer to all prompts | - - - - diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_alpha_scale.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_alpha_scale.md deleted file mode 100644 index f783f3335c7..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_alpha_scale.md +++ /dev/null @@ -1,15 +0,0 @@ -# docker compose alpha scale - - -Scale services - -### Options - -| Name | Type | Default | Description | -|:------------|:-----|:--------|:--------------------------------| -| `--dry-run` | | | Execute command in dry run mode | -| `--no-deps` | | | Don't start linked services | - - - - diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_alpha_viz.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_alpha_viz.md deleted file mode 100644 index 1a05aaac14d..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_alpha_viz.md +++ /dev/null @@ -1,19 +0,0 @@ -# docker compose alpha viz - - -EXPERIMENTAL - Generate a graphviz graph from your compose file - -### Options - -| Name | Type | Default | Description | -|:---------------------|:-------|:--------|:---------------------------------------------------------------------------------------------------| -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `--image` | `bool` | | Include service's image name in output graph | -| `--indentation-size` | `int` | `1` | Number of tabs or spaces to use for indentation | -| `--networks` | `bool` | | Include service's attached networks in output graph | -| `--ports` | `bool` | | Include service's exposed ports in output graph | -| `--spaces` | `bool` | | If given, space character ' ' will be used to indent,
otherwise tab character '\t' will be used | - - - - diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_alpha_watch.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_alpha_watch.md deleted file mode 100644 index aa8130e7a02..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_alpha_watch.md +++ /dev/null @@ -1,16 +0,0 @@ -# docker compose alpha watch - - -Watch build context for service and rebuild/refresh containers when files are updated - -### Options - -| Name | Type | Default | Description | -|:------------|:-----|:--------|:----------------------------------------------| -| `--dry-run` | | | Execute command in dry run mode | -| `--no-up` | | | Do not build & start services before watching | -| `--quiet` | | | hide build output | - - - - diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_attach.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_attach.md deleted file mode 100644 index 0b9ede1e01a..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_attach.md +++ /dev/null @@ -1,17 +0,0 @@ -# docker compose attach - - -Attach local standard input, output, and error streams to a service's running container - -### Options - -| Name | Type | Default | Description | -|:----------------|:---------|:--------|:----------------------------------------------------------| -| `--detach-keys` | `string` | | Override the key sequence for detaching from a container. | -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `--index` | `int` | `0` | index of the container if service has multiple replicas. | -| `--no-stdin` | `bool` | | Do not attach STDIN | -| `--sig-proxy` | `bool` | `true` | Proxy all received signals to the process | - - - diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_bridge.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_bridge.md deleted file mode 100644 index 78d3da4934c..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_bridge.md +++ /dev/null @@ -1,22 +0,0 @@ -# docker compose bridge - - -Convert compose files into another model - -### Subcommands - -| Name | Description | -|:-------------------------------------------------------|:-----------------------------------------------------------------------------| -| [`convert`](compose_bridge_convert.md) | Convert compose files to Kubernetes manifests, Helm charts, or another model | -| [`transformations`](compose_bridge_transformations.md) | Manage transformation images | - - -### Options - -| Name | Type | Default | Description | -|:------------|:-------|:--------|:--------------------------------| -| `--dry-run` | `bool` | | Execute command in dry run mode | - - - - diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_bridge_convert.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_bridge_convert.md deleted file mode 100644 index d4b91ba172d..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_bridge_convert.md +++ /dev/null @@ -1,17 +0,0 @@ -# docker compose bridge convert - - -Convert compose files to Kubernetes manifests, Helm charts, or another model - -### Options - -| Name | Type | Default | Description | -|:-------------------------|:--------------|:--------|:-------------------------------------------------------------------------------------| -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `-o`, `--output` | `string` | `out` | The output directory for the Kubernetes resources | -| `--templates` | `string` | | Directory containing transformation templates | -| `-t`, `--transformation` | `stringArray` | | Transformation to apply to compose model (default: docker/compose-bridge-kubernetes) | - - - - diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_bridge_transformations.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_bridge_transformations.md deleted file mode 100644 index 1e1c7be392b..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_bridge_transformations.md +++ /dev/null @@ -1,22 +0,0 @@ -# docker compose bridge transformations - - -Manage transformation images - -### Subcommands - -| Name | Description | -|:-----------------------------------------------------|:-------------------------------| -| [`create`](compose_bridge_transformations_create.md) | Create a new transformation | -| [`list`](compose_bridge_transformations_list.md) | List available transformations | - - -### Options - -| Name | Type | Default | Description | -|:------------|:-------|:--------|:--------------------------------| -| `--dry-run` | `bool` | | Execute command in dry run mode | - - - - diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_bridge_transformations_create.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_bridge_transformations_create.md deleted file mode 100644 index 187e8d9eca3..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_bridge_transformations_create.md +++ /dev/null @@ -1,15 +0,0 @@ -# docker compose bridge transformations create - - -Create a new transformation - -### Options - -| Name | Type | Default | Description | -|:---------------|:---------|:--------|:----------------------------------------------------------------------------| -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `-f`, `--from` | `string` | | Existing transformation to copy (default: docker/compose-bridge-kubernetes) | - - - - diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_bridge_transformations_list.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_bridge_transformations_list.md deleted file mode 100644 index ce0a5e6911a..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_bridge_transformations_list.md +++ /dev/null @@ -1,20 +0,0 @@ -# docker compose bridge transformations list - - -List available transformations - -### Aliases - -`docker compose bridge transformations list`, `docker compose bridge transformations ls` - -### Options - -| Name | Type | Default | Description | -|:----------------|:---------|:--------|:-------------------------------------------| -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `--format` | `string` | `table` | Format the output. Values: [table \| json] | -| `-q`, `--quiet` | `bool` | | Only display transformer names | - - - - diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_build.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_build.md deleted file mode 100644 index a715974dfa5..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_build.md +++ /dev/null @@ -1,46 +0,0 @@ -# docker compose build - - -Services are built once and then tagged, by default as `project-service`. - -If the Compose file specifies an -[image](https://github.com/compose-spec/compose-spec/blob/main/spec.md#image) name, -the image is tagged with that name, substituting any variables beforehand. See -[variable interpolation](https://github.com/compose-spec/compose-spec/blob/main/spec.md#interpolation). - -If you change a service's `Dockerfile` or the contents of its build directory, -run `docker compose build` to rebuild it. - -### Options - -| Name | Type | Default | Description | -|:----------------------|:--------------|:--------|:------------------------------------------------------------------------------------------------------------| -| `--build-arg` | `stringArray` | | Set build-time variables for services | -| `--builder` | `string` | | Set builder to use | -| `--check` | `bool` | | Check build configuration | -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `-m`, `--memory` | `bytes` | `0` | Set memory limit for the build container. Not supported by BuildKit. | -| `--no-cache` | `bool` | | Do not use cache when building the image | -| `--print` | `bool` | | Print equivalent bake file | -| `--provenance` | `string` | | Add a provenance attestation | -| `--pull` | `bool` | | Always attempt to pull a newer version of the image | -| `--push` | `bool` | | Push service images | -| `-q`, `--quiet` | `bool` | | Suppress the build output | -| `--sbom` | `string` | | Add a SBOM attestation | -| `--ssh` | `string` | | Set SSH authentications used when building service images. (use 'default' for using your default SSH Agent) | -| `--with-dependencies` | `bool` | | Also build dependencies (transitively) | - - - - -## Description - -Services are built once and then tagged, by default as `project-service`. - -If the Compose file specifies an -[image](https://github.com/compose-spec/compose-spec/blob/main/spec.md#image) name, -the image is tagged with that name, substituting any variables beforehand. See -[variable interpolation](https://github.com/compose-spec/compose-spec/blob/main/spec.md#interpolation). - -If you change a service's `Dockerfile` or the contents of its build directory, -run `docker compose build` to rebuild it. diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_commit.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_commit.md deleted file mode 100644 index 1aad40931f9..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_commit.md +++ /dev/null @@ -1,19 +0,0 @@ -# docker compose commit - - -Create a new image from a service container's changes - -### Options - -| Name | Type | Default | Description | -|:------------------|:---------|:--------|:-----------------------------------------------------------| -| `-a`, `--author` | `string` | | Author (e.g., "John Hannibal Smith ") | -| `-c`, `--change` | `list` | | Apply Dockerfile instruction to the created image | -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `--index` | `int` | `0` | index of the container if service has multiple replicas. | -| `-m`, `--message` | `string` | | Commit message | -| `-p`, `--pause` | `bool` | `true` | Pause container during commit | - - - - diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_config.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_config.md deleted file mode 100644 index e2e773feae5..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_config.md +++ /dev/null @@ -1,40 +0,0 @@ -# docker compose convert - - -`docker compose config` renders the actual data model to be applied on the Docker Engine. -It merges the Compose files set by `-f` flags, resolves variables in the Compose file, and expands short-notation into -the canonical format. - -### Options - -| Name | Type | Default | Description | -|:--------------------------|:---------|:--------|:----------------------------------------------------------------------------| -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `--environment` | `bool` | | Print environment used for interpolation. | -| `--format` | `string` | | Format the output. Values: [yaml \| json] | -| `--hash` | `string` | | Print the service config hash, one per line. | -| `--images` | `bool` | | Print the image names, one per line. | -| `--lock-image-digests` | `bool` | | Produces an override file with image digests | -| `--models` | `bool` | | Print the model names, one per line. | -| `--networks` | `bool` | | Print the network names, one per line. | -| `--no-consistency` | `bool` | | Don't check model consistency - warning: may produce invalid Compose output | -| `--no-env-resolution` | `bool` | | Don't resolve service env files | -| `--no-interpolate` | `bool` | | Don't interpolate environment variables | -| `--no-normalize` | `bool` | | Don't normalize compose model | -| `--no-path-resolution` | `bool` | | Don't resolve file paths | -| `-o`, `--output` | `string` | | Save to file (default to stdout) | -| `--profiles` | `bool` | | Print the profile names, one per line. | -| `-q`, `--quiet` | `bool` | | Only validate the configuration, don't print anything | -| `--resolve-image-digests` | `bool` | | Pin image tags to digests | -| `--services` | `bool` | | Print the service names, one per line. | -| `--variables` | `bool` | | Print model variables and default values. | -| `--volumes` | `bool` | | Print the volume names, one per line. | - - - - -## Description - -`docker compose config` renders the actual data model to be applied on the Docker Engine. -It merges the Compose files set by `-f` flags, resolves variables in the Compose file, and expands short-notation into -the canonical format. diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_cp.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_cp.md deleted file mode 100644 index 0886bbd9f94..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_cp.md +++ /dev/null @@ -1,18 +0,0 @@ -# docker compose cp - - -Copy files/folders between a service container and the local filesystem - -### Options - -| Name | Type | Default | Description | -|:----------------------|:-------|:--------|:--------------------------------------------------------| -| `--all` | `bool` | | Include containers created by the run command | -| `-a`, `--archive` | `bool` | | Archive mode (copy all uid/gid information) | -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `-L`, `--follow-link` | `bool` | | Always follow symbol link in SRC_PATH | -| `--index` | `int` | `0` | Index of the container if service has multiple replicas | - - - - diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_create.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_create.md deleted file mode 100644 index 4b0b876da91..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_create.md +++ /dev/null @@ -1,23 +0,0 @@ -# docker compose create - - -Creates containers for a service - -### Options - -| Name | Type | Default | Description | -|:-------------------|:--------------|:---------|:----------------------------------------------------------------------------------------------| -| `--build` | `bool` | | Build images before starting containers | -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `--force-recreate` | `bool` | | Recreate containers even if their configuration and image haven't changed | -| `--no-build` | `bool` | | Don't build an image, even if it's policy | -| `--no-recreate` | `bool` | | If containers already exist, don't recreate them. Incompatible with --force-recreate. | -| `--pull` | `string` | `policy` | Pull image before running ("always"\|"missing"\|"never"\|"build") | -| `--quiet-pull` | `bool` | | Pull without printing progress information | -| `--remove-orphans` | `bool` | | Remove containers for services not defined in the Compose file | -| `--scale` | `stringArray` | | Scale SERVICE to NUM instances. Overrides the `scale` setting in the Compose file if present. | -| `-y`, `--yes` | `bool` | | Assume "yes" as answer to all prompts and run non-interactively | - - - - diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_down.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_down.md deleted file mode 100644 index 2ac0bf2da42..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_down.md +++ /dev/null @@ -1,45 +0,0 @@ -# docker compose down - - -Stops containers and removes containers, networks, volumes, and images created by `up`. - -By default, the only things removed are: - -- Containers for services defined in the Compose file. -- Networks defined in the networks section of the Compose file. -- The default network, if one is used. - -Networks and volumes defined as external are never removed. - -Anonymous volumes are not removed by default. However, as they don’t have a stable name, they are not automatically -mounted by a subsequent `up`. For data that needs to persist between updates, use explicit paths as bind mounts or -named volumes. - -### Options - -| Name | Type | Default | Description | -|:-------------------|:---------|:--------|:------------------------------------------------------------------------------------------------------------------------| -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `--remove-orphans` | `bool` | | Remove containers for services not defined in the Compose file | -| `--rmi` | `string` | | Remove images used by services. "local" remove only images that don't have a custom tag ("local"\|"all") | -| `-t`, `--timeout` | `int` | `0` | Specify a shutdown timeout in seconds | -| `-v`, `--volumes` | `bool` | | Remove named volumes declared in the "volumes" section of the Compose file and anonymous volumes attached to containers | - - - - -## Description - -Stops containers and removes containers, networks, volumes, and images created by `up`. - -By default, the only things removed are: - -- Containers for services defined in the Compose file. -- Networks defined in the networks section of the Compose file. -- The default network, if one is used. - -Networks and volumes defined as external are never removed. - -Anonymous volumes are not removed by default. However, as they don’t have a stable name, they are not automatically -mounted by a subsequent `up`. For data that needs to persist between updates, use explicit paths as bind mounts or -named volumes. diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_events.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_events.md deleted file mode 100644 index 066b5cf3831..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_events.md +++ /dev/null @@ -1,56 +0,0 @@ -# docker compose events - - -Stream container events for every container in the project. - -With the `--json` flag, a json object is printed one per line with the format: - -```json -{ - "time": "2015-11-20T18:01:03.615550", - "type": "container", - "action": "create", - "id": "213cf7...5fc39a", - "service": "web", - "attributes": { - "name": "application_web_1", - "image": "alpine:edge" - } -} -``` - -The events that can be received using this can be seen [here](/reference/cli/docker/system/events/#object-types). - -### Options - -| Name | Type | Default | Description | -|:------------|:---------|:--------|:------------------------------------------| -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `--json` | `bool` | | Output events as a stream of json objects | -| `--since` | `string` | | Show all events created since timestamp | -| `--until` | `string` | | Stream events until this timestamp | - - - - -## Description - -Stream container events for every container in the project. - -With the `--json` flag, a json object is printed one per line with the format: - -```json -{ - "time": "2015-11-20T18:01:03.615550", - "type": "container", - "action": "create", - "id": "213cf7...5fc39a", - "service": "web", - "attributes": { - "name": "application_web_1", - "image": "alpine:edge" - } -} -``` - -The events that can be received using this can be seen [here](https://docs.docker.com/reference/cli/docker/system/events/#object-types). diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_exec.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_exec.md deleted file mode 100644 index 312219e7316..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_exec.md +++ /dev/null @@ -1,42 +0,0 @@ -# docker compose exec - - -This is the equivalent of `docker exec` targeting a Compose service. - -With this subcommand, you can run arbitrary commands in your services. Commands allocate a TTY by default, so -you can use a command such as `docker compose exec web sh` to get an interactive prompt. - -By default, Compose will enter container in interactive mode and allocate a TTY, while the equivalent `docker exec` -command requires passing `--interactive --tty` flags to get the same behavior. Compose also support those two flags -to offer a smooth migration between commands, whenever they are no-op by default. Still, `interactive` can be used to -force disabling interactive mode (`--interactive=false`), typically when `docker compose exec` command is used inside -a script. - -### Options - -| Name | Type | Default | Description | -|:------------------|:--------------|:--------|:---------------------------------------------------------------------------------| -| `-d`, `--detach` | `bool` | | Detached mode: Run command in the background | -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `-e`, `--env` | `stringArray` | | Set environment variables | -| `--index` | `int` | `0` | Index of the container if service has multiple replicas | -| `-T`, `--no-tty` | `bool` | `true` | Disable pseudo-TTY allocation. By default 'docker compose exec' allocates a TTY. | -| `--privileged` | `bool` | | Give extended privileges to the process | -| `-u`, `--user` | `string` | | Run the command as this user | -| `-w`, `--workdir` | `string` | | Path to workdir directory for this command | - - - - -## Description - -This is the equivalent of `docker exec` targeting a Compose service. - -With this subcommand, you can run arbitrary commands in your services. Commands allocate a TTY by default, so -you can use a command such as `docker compose exec web sh` to get an interactive prompt. - -By default, Compose will enter container in interactive mode and allocate a TTY, while the equivalent `docker exec` -command requires passing `--interactive --tty` flags to get the same behavior. Compose also support those two flags -to offer a smooth migration between commands, whenever they are no-op by default. Still, `interactive` can be used to -force disabling interactive mode (`--interactive=false`), typically when `docker compose exec` command is used inside -a script. \ No newline at end of file diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_export.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_export.md deleted file mode 100644 index 942ea6a347f..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_export.md +++ /dev/null @@ -1,16 +0,0 @@ -# docker compose export - - -Export a service container's filesystem as a tar archive - -### Options - -| Name | Type | Default | Description | -|:-----------------|:---------|:--------|:---------------------------------------------------------| -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `--index` | `int` | `0` | index of the container if service has multiple replicas. | -| `-o`, `--output` | `string` | | Write to a file, instead of STDOUT | - - - - diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_images.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_images.md deleted file mode 100644 index 1e4e0259b1d..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_images.md +++ /dev/null @@ -1,16 +0,0 @@ -# docker compose images - - -List images used by the created containers - -### Options - -| Name | Type | Default | Description | -|:----------------|:---------|:--------|:-------------------------------------------| -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `--format` | `string` | `table` | Format the output. Values: [table \| json] | -| `-q`, `--quiet` | `bool` | | Only display IDs | - - - - diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_kill.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_kill.md deleted file mode 100644 index 0b6c1d05f01..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_kill.md +++ /dev/null @@ -1,27 +0,0 @@ -# docker compose kill - - -Forces running containers to stop by sending a `SIGKILL` signal. Optionally the signal can be passed, for example: - -```console -$ docker compose kill -s SIGINT -``` - -### Options - -| Name | Type | Default | Description | -|:-------------------|:---------|:----------|:---------------------------------------------------------------| -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `--remove-orphans` | `bool` | | Remove containers for services not defined in the Compose file | -| `-s`, `--signal` | `string` | `SIGKILL` | SIGNAL to send to the container | - - - - -## Description - -Forces running containers to stop by sending a `SIGKILL` signal. Optionally the signal can be passed, for example: - -```console -$ docker compose kill -s SIGINT -``` diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_logs.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_logs.md deleted file mode 100644 index 4c8ba7e3486..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_logs.md +++ /dev/null @@ -1,25 +0,0 @@ -# docker compose logs - - -Displays log output from services - -### Options - -| Name | Type | Default | Description | -|:---------------------|:---------|:--------|:-----------------------------------------------------------------------------------------------| -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `-f`, `--follow` | `bool` | | Follow log output | -| `--index` | `int` | `0` | index of the container if service has multiple replicas | -| `--no-color` | `bool` | | Produce monochrome output | -| `--no-log-prefix` | `bool` | | Don't print prefix in logs | -| `--since` | `string` | | Show logs since timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes) | -| `-n`, `--tail` | `string` | `all` | Number of lines to show from the end of the logs for each container | -| `-t`, `--timestamps` | `bool` | | Show timestamps | -| `--until` | `string` | | Show logs before a timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes) | - - - - -## Description - -Displays log output from services diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_ls.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_ls.md deleted file mode 100644 index 7719d208609..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_ls.md +++ /dev/null @@ -1,21 +0,0 @@ -# docker compose ls - - -Lists running Compose projects - -### Options - -| Name | Type | Default | Description | -|:----------------|:---------|:--------|:-------------------------------------------| -| `-a`, `--all` | `bool` | | Show all stopped Compose projects | -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `--filter` | `filter` | | Filter output based on conditions provided | -| `--format` | `string` | `table` | Format the output. Values: [table \| json] | -| `-q`, `--quiet` | `bool` | | Only display project names | - - - - -## Description - -Lists running Compose projects diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_pause.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_pause.md deleted file mode 100644 index 4a0d5bdcc03..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_pause.md +++ /dev/null @@ -1,17 +0,0 @@ -# docker compose pause - - -Pauses running containers of a service. They can be unpaused with `docker compose unpause`. - -### Options - -| Name | Type | Default | Description | -|:------------|:-------|:--------|:--------------------------------| -| `--dry-run` | `bool` | | Execute command in dry run mode | - - - - -## Description - -Pauses running containers of a service. They can be unpaused with `docker compose unpause`. \ No newline at end of file diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_port.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_port.md deleted file mode 100644 index bbbfbf15616..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_port.md +++ /dev/null @@ -1,19 +0,0 @@ -# docker compose port - - -Prints the public port for a port binding - -### Options - -| Name | Type | Default | Description | -|:-------------|:---------|:--------|:--------------------------------------------------------| -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `--index` | `int` | `0` | Index of the container if service has multiple replicas | -| `--protocol` | `string` | `tcp` | tcp or udp | - - - - -## Description - -Prints the public port for a port binding diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_ps.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_ps.md deleted file mode 100644 index 3572c530556..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_ps.md +++ /dev/null @@ -1,138 +0,0 @@ -# docker compose ps - - -Lists containers for a Compose project, with current status and exposed ports. - -```console -$ docker compose ps -NAME IMAGE COMMAND SERVICE CREATED STATUS PORTS -example-foo-1 alpine "/entrypoint.…" foo 4 seconds ago Up 2 seconds 0.0.0.0:8080->80/tcp -``` - -By default, only running containers are shown. `--all` flag can be used to include stopped containers. - -```console -$ docker compose ps --all -NAME IMAGE COMMAND SERVICE CREATED STATUS PORTS -example-foo-1 alpine "/entrypoint.…" foo 4 seconds ago Up 2 seconds 0.0.0.0:8080->80/tcp -example-bar-1 alpine "/entrypoint.…" bar 4 seconds ago exited (0) -``` - -### Options - -| Name | Type | Default | Description | -|:----------------------|:--------------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `-a`, `--all` | `bool` | | Show all stopped containers (including those created by the run command) | -| `--dry-run` | `bool` | | Execute command in dry run mode | -| [`--filter`](#filter) | `string` | | Filter services by a property (supported filters: status) | -| [`--format`](#format) | `string` | `table` | Format output using a custom template:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | -| `--no-trunc` | `bool` | | Don't truncate output | -| `--orphans` | `bool` | `true` | Include orphaned services (not declared by project) | -| `-q`, `--quiet` | `bool` | | Only display IDs | -| `--services` | `bool` | | Display services | -| [`--status`](#status) | `stringArray` | | Filter services by status. Values: [paused \| restarting \| removing \| running \| dead \| created \| exited] | - - - - -## Description - -Lists containers for a Compose project, with current status and exposed ports. - -```console -$ docker compose ps -NAME IMAGE COMMAND SERVICE CREATED STATUS PORTS -example-foo-1 alpine "/entrypoint.…" foo 4 seconds ago Up 2 seconds 0.0.0.0:8080->80/tcp -``` - -By default, only running containers are shown. `--all` flag can be used to include stopped containers. - -```console -$ docker compose ps --all -NAME IMAGE COMMAND SERVICE CREATED STATUS PORTS -example-foo-1 alpine "/entrypoint.…" foo 4 seconds ago Up 2 seconds 0.0.0.0:8080->80/tcp -example-bar-1 alpine "/entrypoint.…" bar 4 seconds ago exited (0) -``` - -## Examples - -### Format the output (--format) - -By default, the `docker compose ps` command uses a table ("pretty") format to -show the containers. The `--format` flag allows you to specify alternative -presentations for the output. Currently, supported options are `pretty` (default), -and `json`, which outputs information about the containers as a JSON array: - -```console -$ docker compose ps --format json -[{"ID":"1553b0236cf4d2715845f053a4ee97042c4f9a2ef655731ee34f1f7940eaa41a","Name":"example-bar-1","Command":"/docker-entrypoint.sh nginx -g 'daemon off;'","Project":"example","Service":"bar","State":"exited","Health":"","ExitCode":0,"Publishers":null},{"ID":"f02a4efaabb67416e1ff127d51c4b5578634a0ad5743bd65225ff7d1909a3fa0","Name":"example-foo-1","Command":"/docker-entrypoint.sh nginx -g 'daemon off;'","Project":"example","Service":"foo","State":"running","Health":"","ExitCode":0,"Publishers":[{"URL":"0.0.0.0","TargetPort":80,"PublishedPort":8080,"Protocol":"tcp"}]}] -``` - -The JSON output allows you to use the information in other tools for further -processing, for example, using the [`jq` utility](https://stedolan.github.io/jq/) -to pretty-print the JSON: - -```console -$ docker compose ps --format json | jq . -[ - { - "ID": "1553b0236cf4d2715845f053a4ee97042c4f9a2ef655731ee34f1f7940eaa41a", - "Name": "example-bar-1", - "Command": "/docker-entrypoint.sh nginx -g 'daemon off;'", - "Project": "example", - "Service": "bar", - "State": "exited", - "Health": "", - "ExitCode": 0, - "Publishers": null - }, - { - "ID": "f02a4efaabb67416e1ff127d51c4b5578634a0ad5743bd65225ff7d1909a3fa0", - "Name": "example-foo-1", - "Command": "/docker-entrypoint.sh nginx -g 'daemon off;'", - "Project": "example", - "Service": "foo", - "State": "running", - "Health": "", - "ExitCode": 0, - "Publishers": [ - { - "URL": "0.0.0.0", - "TargetPort": 80, - "PublishedPort": 8080, - "Protocol": "tcp" - } - ] - } -] -``` - -### Filter containers by status (--status) - -Use the `--status` flag to filter the list of containers by status. For example, -to show only containers that are running or only containers that have exited: - -```console -$ docker compose ps --status=running -NAME IMAGE COMMAND SERVICE CREATED STATUS PORTS -example-foo-1 alpine "/entrypoint.…" foo 4 seconds ago Up 2 seconds 0.0.0.0:8080->80/tcp - -$ docker compose ps --status=exited -NAME IMAGE COMMAND SERVICE CREATED STATUS PORTS -example-bar-1 alpine "/entrypoint.…" bar 4 seconds ago exited (0) -``` - -### Filter containers by status (--filter) - -The [`--status` flag](#status) is a convenient shorthand for the `--filter status=` -flag. The example below is the equivalent to the example from the previous section, -this time using the `--filter` flag: - -```console -$ docker compose ps --filter status=running -NAME IMAGE COMMAND SERVICE CREATED STATUS PORTS -example-foo-1 alpine "/entrypoint.…" foo 4 seconds ago Up 2 seconds 0.0.0.0:8080->80/tcp -``` - -The `docker compose ps` command currently only supports the `--filter status=` -option, but additional filter options may be added in the future. diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_publish.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_publish.md deleted file mode 100644 index 9a82fc260a7..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_publish.md +++ /dev/null @@ -1,19 +0,0 @@ -# docker compose publish - - -Publish compose application - -### Options - -| Name | Type | Default | Description | -|:--------------------------|:---------|:--------|:-------------------------------------------------------------------------------| -| `--app` | `bool` | | Published compose application (includes referenced images) | -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `--oci-version` | `string` | | OCI image/artifact specification version (automatically determined by default) | -| `--resolve-image-digests` | `bool` | | Pin image tags to digests | -| `--with-env` | `bool` | | Include environment variables in the published OCI artifact | -| `-y`, `--yes` | `bool` | | Assume "yes" as answer to all prompts | - - - - diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_pull.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_pull.md deleted file mode 100644 index 6a47f9d509f..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_pull.md +++ /dev/null @@ -1,68 +0,0 @@ -# docker compose pull - - -Pulls an image associated with a service defined in a `compose.yaml` file, but does not start containers based on those images - -### Options - -| Name | Type | Default | Description | -|:-------------------------|:---------|:--------|:-------------------------------------------------------| -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `--ignore-buildable` | `bool` | | Ignore images that can be built | -| `--ignore-pull-failures` | `bool` | | Pull what it can and ignores images with pull failures | -| `--include-deps` | `bool` | | Also pull services declared as dependencies | -| `--policy` | `string` | | Apply pull policy ("missing"\|"always") | -| `-q`, `--quiet` | `bool` | | Pull without printing progress information | - - - - -## Description - -Pulls an image associated with a service defined in a `compose.yaml` file, but does not start containers based on those images - - -## Examples - -Consider the following `compose.yaml`: - -```yaml -services: - db: - image: postgres - web: - build: . - command: bundle exec rails s -p 3000 -b '0.0.0.0' - volumes: - - .:/myapp - ports: - - "3000:3000" - depends_on: - - db -``` - -If you run `docker compose pull ServiceName` in the same directory as the `compose.yaml` file that defines the service, -Docker pulls the associated image. For example, to call the postgres image configured as the db service in our example, -you would run `docker compose pull db`. - -```console -$ docker compose pull db -[+] Running 1/15 - ⠸ db Pulling 12.4s - ⠿ 45b42c59be33 Already exists 0.0s - ⠹ 40adec129f1a Downloading 3.374MB/4.178MB 9.3s - ⠹ b4c431d00c78 Download complete 9.3s - ⠹ 2696974e2815 Download complete 9.3s - ⠹ 564b77596399 Downloading 5.622MB/7.965MB 9.3s - ⠹ 5044045cf6f2 Downloading 216.7kB/391.1kB 9.3s - ⠹ d736e67e6ac3 Waiting 9.3s - ⠹ 390c1c9a5ae4 Waiting 9.3s - ⠹ c0e62f172284 Waiting 9.3s - ⠹ ebcdc659c5bf Waiting 9.3s - ⠹ 29be22cb3acc Waiting 9.3s - ⠹ f63c47038e66 Waiting 9.3s - ⠹ 77a0c198cde5 Waiting 9.3s - ⠹ c8752d5b785c Waiting 9.3s -``` - -`docker compose pull` tries to pull image for services with a build section. If pull fails, it lets you know this service image must be built. You can skip this by setting `--ignore-buildable` flag. diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_push.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_push.md deleted file mode 100644 index 0efc48c46d3..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_push.md +++ /dev/null @@ -1,54 +0,0 @@ -# docker compose push - - -Pushes images for services to their respective registry/repository. - -The following assumptions are made: -- You are pushing an image you have built locally -- You have access to the build key - -Examples - -```yaml -services: - service1: - build: . - image: localhost:5000/yourimage ## goes to local registry - - service2: - build: . - image: your-dockerid/yourimage ## goes to your repository on Docker Hub -``` - -### Options - -| Name | Type | Default | Description | -|:-------------------------|:-------|:--------|:-------------------------------------------------------| -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `--ignore-push-failures` | `bool` | | Push what it can and ignores images with push failures | -| `--include-deps` | `bool` | | Also push images of services declared as dependencies | -| `-q`, `--quiet` | `bool` | | Push without printing progress information | - - - - -## Description - -Pushes images for services to their respective registry/repository. - -The following assumptions are made: -- You are pushing an image you have built locally -- You have access to the build key - -Examples - -```yaml -services: - service1: - build: . - image: localhost:5000/yourimage ## goes to local registry - - service2: - build: . - image: your-dockerid/yourimage ## goes to your repository on Docker Hub -``` diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_restart.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_restart.md deleted file mode 100644 index e57f346a81a..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_restart.md +++ /dev/null @@ -1,37 +0,0 @@ -# docker compose restart - - -Restarts all stopped and running services, or the specified services only. - -If you make changes to your `compose.yml` configuration, these changes are not reflected -after running this command. For example, changes to environment variables (which are added -after a container is built, but before the container's command is executed) are not updated -after restarting. - -If you are looking to configure a service's restart policy, refer to -[restart](https://github.com/compose-spec/compose-spec/blob/main/spec.md#restart) -or [restart_policy](https://github.com/compose-spec/compose-spec/blob/main/deploy.md#restart_policy). - -### Options - -| Name | Type | Default | Description | -|:------------------|:-------|:--------|:--------------------------------------| -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `--no-deps` | `bool` | | Don't restart dependent services | -| `-t`, `--timeout` | `int` | `0` | Specify a shutdown timeout in seconds | - - - - -## Description - -Restarts all stopped and running services, or the specified services only. - -If you make changes to your `compose.yml` configuration, these changes are not reflected -after running this command. For example, changes to environment variables (which are added -after a container is built, but before the container's command is executed) are not updated -after restarting. - -If you are looking to configure a service's restart policy, refer to -[restart](https://github.com/compose-spec/compose-spec/blob/main/spec.md#restart) -or [restart_policy](https://github.com/compose-spec/compose-spec/blob/main/deploy.md#restart_policy). diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_rm.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_rm.md deleted file mode 100644 index 5e84930bac3..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_rm.md +++ /dev/null @@ -1,48 +0,0 @@ -# docker compose rm - - -Removes stopped service containers. - -By default, anonymous volumes attached to containers are not removed. You can override this with `-v`. To list all -volumes, use `docker volume ls`. - -Any data which is not in a volume is lost. - -Running the command with no options also removes one-off containers created by `docker compose run`: - -```console -$ docker compose rm -Going to remove djangoquickstart_web_run_1 -Are you sure? [yN] y -Removing djangoquickstart_web_run_1 ... done -``` - -### Options - -| Name | Type | Default | Description | -|:------------------|:-------|:--------|:----------------------------------------------------| -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `-f`, `--force` | `bool` | | Don't ask to confirm removal | -| `-s`, `--stop` | `bool` | | Stop the containers, if required, before removing | -| `-v`, `--volumes` | `bool` | | Remove any anonymous volumes attached to containers | - - - - -## Description - -Removes stopped service containers. - -By default, anonymous volumes attached to containers are not removed. You can override this with `-v`. To list all -volumes, use `docker volume ls`. - -Any data which is not in a volume is lost. - -Running the command with no options also removes one-off containers created by `docker compose run`: - -```console -$ docker compose rm -Going to remove djangoquickstart_web_run_1 -Are you sure? [yN] y -Removing djangoquickstart_web_run_1 ... done -``` diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_run.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_run.md deleted file mode 100644 index 25b28d1ded8..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_run.md +++ /dev/null @@ -1,145 +0,0 @@ -# docker compose run - - -Runs a one-time command against a service. - -The following command starts the `web` service and runs `bash` as its command: - -```console -$ docker compose run web bash -``` - -Commands you use with run start in new containers with configuration defined by that of the service, -including volumes, links, and other details. However, there are two important differences: - -First, the command passed by `run` overrides the command defined in the service configuration. For example, if the -`web` service configuration is started with `bash`, then `docker compose run web python app.py` overrides it with -`python app.py`. - -The second difference is that the `docker compose run` command does not create any of the ports specified in the -service configuration. This prevents port collisions with already-open ports. If you do want the service’s ports -to be created and mapped to the host, specify the `--service-ports` - -```console -$ docker compose run --service-ports web python manage.py shell -``` - -Alternatively, manual port mapping can be specified with the `--publish` or `-p` options, just as when using docker run: - -```console -$ docker compose run --publish 8080:80 -p 2022:22 -p 127.0.0.1:2021:21 web python manage.py shell -``` - -If you start a service configured with links, the run command first checks to see if the linked service is running -and starts the service if it is stopped. Once all the linked services are running, the run executes the command you -passed it. For example, you could run: - -```console -$ docker compose run db psql -h db -U docker -``` - -This opens an interactive PostgreSQL shell for the linked `db` container. - -If you do not want the run command to start linked containers, use the `--no-deps` flag: - -```console -$ docker compose run --no-deps web python manage.py shell -``` - -If you want to remove the container after running while overriding the container’s restart policy, use the `--rm` flag: - -```console -$ docker compose run --rm web python manage.py db upgrade -``` - -This runs a database upgrade script, and removes the container when finished running, even if a restart policy is -specified in the service configuration. - -### Options - -| Name | Type | Default | Description | -|:------------------------|:--------------|:---------|:---------------------------------------------------------------------------------| -| `--build` | `bool` | | Build image before starting container | -| `--cap-add` | `list` | | Add Linux capabilities | -| `--cap-drop` | `list` | | Drop Linux capabilities | -| `-d`, `--detach` | `bool` | | Run container in background and print container ID | -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `--entrypoint` | `string` | | Override the entrypoint of the image | -| `-e`, `--env` | `stringArray` | | Set environment variables | -| `--env-from-file` | `stringArray` | | Set environment variables from file | -| `-i`, `--interactive` | `bool` | `true` | Keep STDIN open even if not attached | -| `-l`, `--label` | `stringArray` | | Add or override a label | -| `--name` | `string` | | Assign a name to the container | -| `-T`, `--no-TTY` | `bool` | `true` | Disable pseudo-TTY allocation (default: auto-detected) | -| `--no-deps` | `bool` | | Don't start linked services | -| `-p`, `--publish` | `stringArray` | | Publish a container's port(s) to the host | -| `--pull` | `string` | `policy` | Pull image before running ("always"\|"missing"\|"never") | -| `-q`, `--quiet` | `bool` | | Don't print anything to STDOUT | -| `--quiet-build` | `bool` | | Suppress progress output from the build process | -| `--quiet-pull` | `bool` | | Pull without printing progress information | -| `--remove-orphans` | `bool` | | Remove containers for services not defined in the Compose file | -| `--rm` | `bool` | | Automatically remove the container when it exits | -| `-P`, `--service-ports` | `bool` | | Run command with all service's ports enabled and mapped to the host | -| `--use-aliases` | `bool` | | Use the service's network useAliases in the network(s) the container connects to | -| `-u`, `--user` | `string` | | Run as specified username or uid | -| `-v`, `--volume` | `stringArray` | | Bind mount a volume | -| `-w`, `--workdir` | `string` | | Working directory inside the container | - - - - -## Description - -Runs a one-time command against a service. - -The following command starts the `web` service and runs `bash` as its command: - -```console -$ docker compose run web bash -``` - -Commands you use with run start in new containers with configuration defined by that of the service, -including volumes, links, and other details. However, there are two important differences: - -First, the command passed by `run` overrides the command defined in the service configuration. For example, if the -`web` service configuration is started with `bash`, then `docker compose run web python app.py` overrides it with -`python app.py`. - -The second difference is that the `docker compose run` command does not create any of the ports specified in the -service configuration. This prevents port collisions with already-open ports. If you do want the service’s ports -to be created and mapped to the host, specify the `--service-ports` - -```console -$ docker compose run --service-ports web python manage.py shell -``` - -Alternatively, manual port mapping can be specified with the `--publish` or `-p` options, just as when using docker run: - -```console -$ docker compose run --publish 8080:80 -p 2022:22 -p 127.0.0.1:2021:21 web python manage.py shell -``` - -If you start a service configured with links, the run command first checks to see if the linked service is running -and starts the service if it is stopped. Once all the linked services are running, the run executes the command you -passed it. For example, you could run: - -```console -$ docker compose run db psql -h db -U docker -``` - -This opens an interactive PostgreSQL shell for the linked `db` container. - -If you do not want the run command to start linked containers, use the `--no-deps` flag: - -```console -$ docker compose run --no-deps web python manage.py shell -``` - -If you want to remove the container after running while overriding the container’s restart policy, use the `--rm` flag: - -```console -$ docker compose run --rm web python manage.py db upgrade -``` - -This runs a database upgrade script, and removes the container when finished running, even if a restart policy is -specified in the service configuration. diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_scale.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_scale.md deleted file mode 100644 index 3d0dbdb04a2..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_scale.md +++ /dev/null @@ -1,15 +0,0 @@ -# docker compose scale - - -Scale services - -### Options - -| Name | Type | Default | Description | -|:------------|:-------|:--------|:--------------------------------| -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `--no-deps` | `bool` | | Don't start linked services | - - - - diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_start.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_start.md deleted file mode 100644 index 06229e5940e..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_start.md +++ /dev/null @@ -1,19 +0,0 @@ -# docker compose start - - -Starts existing containers for a service - -### Options - -| Name | Type | Default | Description | -|:-----------------|:-------|:--------|:---------------------------------------------------------------------------| -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `--wait` | `bool` | | Wait for services to be running\|healthy. Implies detached mode. | -| `--wait-timeout` | `int` | `0` | Maximum duration in seconds to wait for the project to be running\|healthy | - - - - -## Description - -Starts existing containers for a service diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_stats.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_stats.md deleted file mode 100644 index 78d44b89350..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_stats.md +++ /dev/null @@ -1,18 +0,0 @@ -# docker compose stats - - -Display a live stream of container(s) resource usage statistics - -### Options - -| Name | Type | Default | Description | -|:--------------|:---------|:--------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `-a`, `--all` | `bool` | | Show all containers (default shows just running) | -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `--format` | `string` | | Format output using a custom template:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/engine/cli/formatting/ for more information about formatting output with templates | -| `--no-stream` | `bool` | | Disable streaming stats and only pull the first result | -| `--no-trunc` | `bool` | | Do not truncate output | - - - - diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_stop.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_stop.md deleted file mode 100644 index fe84f24f8f5..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_stop.md +++ /dev/null @@ -1,18 +0,0 @@ -# docker compose stop - - -Stops running containers without removing them. They can be started again with `docker compose start`. - -### Options - -| Name | Type | Default | Description | -|:------------------|:-------|:--------|:--------------------------------------| -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `-t`, `--timeout` | `int` | `0` | Specify a shutdown timeout in seconds | - - - - -## Description - -Stops running containers without removing them. They can be started again with `docker compose start`. diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_top.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_top.md deleted file mode 100644 index eeacb3866aa..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_top.md +++ /dev/null @@ -1,26 +0,0 @@ -# docker compose top - - -Displays the running processes - -### Options - -| Name | Type | Default | Description | -|:------------|:-------|:--------|:--------------------------------| -| `--dry-run` | `bool` | | Execute command in dry run mode | - - - - -## Description - -Displays the running processes - -## Examples - -```console -$ docker compose top -example_foo_1 -UID PID PPID C STIME TTY TIME CMD -root 142353 142331 2 15:33 ? 00:00:00 ping localhost -c 5 -``` diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_unpause.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_unpause.md deleted file mode 100644 index 92841ceade7..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_unpause.md +++ /dev/null @@ -1,17 +0,0 @@ -# docker compose unpause - - -Unpauses paused containers of a service - -### Options - -| Name | Type | Default | Description | -|:------------|:-------|:--------|:--------------------------------| -| `--dry-run` | `bool` | | Execute command in dry run mode | - - - - -## Description - -Unpauses paused containers of a service diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_up.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_up.md deleted file mode 100644 index b7f17a0fac9..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_up.md +++ /dev/null @@ -1,82 +0,0 @@ -# docker compose up - - -Builds, (re)creates, starts, and attaches to containers for a service. - -Unless they are already running, this command also starts any linked services. - -The `docker compose up` command aggregates the output of each container (like `docker compose logs --follow` does). -One can optionally select a subset of services to attach to using `--attach` flag, or exclude some services using -`--no-attach` to prevent output to be flooded by some verbose services. - -When the command exits, all containers are stopped. Running `docker compose up --detach` starts the containers in the -background and leaves them running. - -If there are existing containers for a service, and the service’s configuration or image was changed after the -container’s creation, `docker compose up` picks up the changes by stopping and recreating the containers -(preserving mounted volumes). To prevent Compose from picking up changes, use the `--no-recreate` flag. - -If you want to force Compose to stop and recreate all containers, use the `--force-recreate` flag. - -If the process encounters an error, the exit code for this command is `1`. -If the process is interrupted using `SIGINT` (ctrl + C) or `SIGTERM`, the containers are stopped, and the exit code is `0`. - -### Options - -| Name | Type | Default | Description | -|:-------------------------------|:--------------|:---------|:----------------------------------------------------------------------------------------------------------------------------------------------------| -| `--abort-on-container-exit` | `bool` | | Stops all containers if any container was stopped. Incompatible with -d | -| `--abort-on-container-failure` | `bool` | | Stops all containers if any container exited with failure. Incompatible with -d | -| `--always-recreate-deps` | `bool` | | Recreate dependent containers. Incompatible with --no-recreate. | -| `--attach` | `stringArray` | | Restrict attaching to the specified services. Incompatible with --attach-dependencies. | -| `--attach-dependencies` | `bool` | | Automatically attach to log output of dependent services | -| `--build` | `bool` | | Build images before starting containers | -| `-d`, `--detach` | `bool` | | Detached mode: Run containers in the background | -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `--exit-code-from` | `string` | | Return the exit code of the selected service container. Implies --abort-on-container-exit | -| `--force-recreate` | `bool` | | Recreate containers even if their configuration and image haven't changed | -| `--menu` | `bool` | | Enable interactive shortcuts when running attached. Incompatible with --detach. Can also be enable/disable by setting COMPOSE_MENU environment var. | -| `--no-attach` | `stringArray` | | Do not attach (stream logs) to the specified services | -| `--no-build` | `bool` | | Don't build an image, even if it's policy | -| `--no-color` | `bool` | | Produce monochrome output | -| `--no-deps` | `bool` | | Don't start linked services | -| `--no-log-prefix` | `bool` | | Don't print prefix in logs | -| `--no-recreate` | `bool` | | If containers already exist, don't recreate them. Incompatible with --force-recreate. | -| `--no-start` | `bool` | | Don't start the services after creating them | -| `--pull` | `string` | `policy` | Pull image before running ("always"\|"missing"\|"never") | -| `--quiet-build` | `bool` | | Suppress the build output | -| `--quiet-pull` | `bool` | | Pull without printing progress information | -| `--remove-orphans` | `bool` | | Remove containers for services not defined in the Compose file | -| `-V`, `--renew-anon-volumes` | `bool` | | Recreate anonymous volumes instead of retrieving data from the previous containers | -| `--scale` | `stringArray` | | Scale SERVICE to NUM instances. Overrides the `scale` setting in the Compose file if present. | -| `-t`, `--timeout` | `int` | `0` | Use this timeout in seconds for container shutdown when attached or when containers are already running | -| `--timestamps` | `bool` | | Show timestamps | -| `--wait` | `bool` | | Wait for services to be running\|healthy. Implies detached mode. | -| `--wait-timeout` | `int` | `0` | Maximum duration in seconds to wait for the project to be running\|healthy | -| `-w`, `--watch` | `bool` | | Watch source code and rebuild/refresh containers when files are updated. | -| `-y`, `--yes` | `bool` | | Assume "yes" as answer to all prompts and run non-interactively | - - - - -## Description - -Builds, (re)creates, starts, and attaches to containers for a service. - -Unless they are already running, this command also starts any linked services. - -The `docker compose up` command aggregates the output of each container (like `docker compose logs --follow` does). -One can optionally select a subset of services to attach to using `--attach` flag, or exclude some services using -`--no-attach` to prevent output to be flooded by some verbose services. - -When the command exits, all containers are stopped. Running `docker compose up --detach` starts the containers in the -background and leaves them running. - -If there are existing containers for a service, and the service’s configuration or image was changed after the -container’s creation, `docker compose up` picks up the changes by stopping and recreating the containers -(preserving mounted volumes). To prevent Compose from picking up changes, use the `--no-recreate` flag. - -If you want to force Compose to stop and recreate all containers, use the `--force-recreate` flag. - -If the process encounters an error, the exit code for this command is `1`. -If the process is interrupted using `SIGINT` (ctrl + C) or `SIGTERM`, the containers are stopped, and the exit code is `0`. diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_version.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_version.md deleted file mode 100644 index 3a6329dadb4..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_version.md +++ /dev/null @@ -1,15 +0,0 @@ -# docker compose version - - -Show the Docker Compose version information - -### Options - -| Name | Type | Default | Description | -|:-----------------|:---------|:--------|:---------------------------------------------------------------| -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `-f`, `--format` | `string` | | Format the output. Values: [pretty \| json]. (Default: pretty) | -| `--short` | `bool` | | Shows only Compose's version number | - - - diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_volumes.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_volumes.md deleted file mode 100644 index 6bad874f187..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_volumes.md +++ /dev/null @@ -1,16 +0,0 @@ -# docker compose volumes - - -List volumes - -### Options - -| Name | Type | Default | Description | -|:----------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `--format` | `string` | `table` | Format output using a custom template:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | -| `-q`, `--quiet` | `bool` | | Only display volume names | - - - - diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_wait.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_wait.md deleted file mode 100644 index 59474c9b509..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_wait.md +++ /dev/null @@ -1,15 +0,0 @@ -# docker compose wait - - -Block until containers of all (or specified) services stop. - -### Options - -| Name | Type | Default | Description | -|:-----------------|:-------|:--------|:---------------------------------------------| -| `--down-project` | `bool` | | Drops project when the first container stops | -| `--dry-run` | `bool` | | Execute command in dry run mode | - - - - diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_watch.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_watch.md deleted file mode 100644 index f6040c9094f..00000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_watch.md +++ /dev/null @@ -1,17 +0,0 @@ -# docker compose watch - - -Watch build context for service and rebuild/refresh containers when files are updated - -### Options - -| Name | Type | Default | Description | -|:------------|:-------|:--------|:----------------------------------------------| -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `--no-up` | `bool` | | Do not build & start services before watching | -| `--prune` | `bool` | `true` | Prune dangling images on rebuild | -| `--quiet` | `bool` | | hide build output | - - - - diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model.md b/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model.md deleted file mode 100644 index c34bfbdc4e2..00000000000 --- a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model.md +++ /dev/null @@ -1,45 +0,0 @@ -# docker model - - -Docker Model Runner - -### Subcommands - -| Name | Description | -|:------------------------------------------------|:-----------------------------------------------------------------------| -| [`bench`](model_bench.md) | Benchmark a model's performance at different concurrency levels | -| [`df`](model_df.md) | Show Docker Model Runner disk usage | -| [`inspect`](model_inspect.md) | Display detailed information on one model | -| [`install-runner`](model_install-runner.md) | Install Docker Model Runner (Docker Engine only) | -| [`launch`](model_launch.md) | Launch an app configured to use Docker Model Runner | -| [`list`](model_list.md) | List the models pulled to your local environment | -| [`logs`](model_logs.md) | Fetch the Docker Model Runner logs | -| [`package`](model_package.md) | Package a model into a Docker Model OCI artifact | -| [`ps`](model_ps.md) | List running models | -| [`pull`](model_pull.md) | Pull a model from Docker Hub or HuggingFace to your local environment | -| [`purge`](model_purge.md) | Remove all models | -| [`push`](model_push.md) | Push a model to Docker Hub or Hugging Face | -| [`reinstall-runner`](model_reinstall-runner.md) | Reinstall Docker Model Runner (Docker Engine only) | -| [`requests`](model_requests.md) | Fetch requests+responses from Docker Model Runner | -| [`restart-runner`](model_restart-runner.md) | Restart Docker Model Runner (Docker Engine only) | -| [`rm`](model_rm.md) | Remove local models downloaded from Docker Hub | -| [`run`](model_run.md) | Run a model and interact with it using a submitted prompt or chat mode | -| [`search`](model_search.md) | Search for models on Docker Hub and HuggingFace | -| [`show`](model_show.md) | Show information for a model | -| [`skills`](model_skills.md) | Install Docker Model Runner skills for AI coding assistants | -| [`start-runner`](model_start-runner.md) | Start Docker Model Runner (Docker Engine only) | -| [`status`](model_status.md) | Check if the Docker Model Runner is running | -| [`stop-runner`](model_stop-runner.md) | Stop Docker Model Runner (Docker Engine only) | -| [`tag`](model_tag.md) | Tag a model | -| [`uninstall-runner`](model_uninstall-runner.md) | Uninstall Docker Model Runner (Docker Engine only) | -| [`unload`](model_unload.md) | Unload running models | -| [`version`](model_version.md) | Show the Docker Model Runner version | - - - - - -## Description - -Use Docker Model Runner to run and interact with AI models directly from the command line. -For more information, see the [documentation](https://docs.docker.com/ai/model-runner/) diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_bench.md b/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_bench.md deleted file mode 100644 index fbeaf5ac535..00000000000 --- a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_bench.md +++ /dev/null @@ -1,21 +0,0 @@ -# docker model bench - - -Benchmark a model's performance showing tokens per second at different concurrency levels. - -This command runs a series of benchmarks with 1, 2, 4, and 8 concurrent requests by default, -measuring the tokens per second (TPS) that the model can generate. - -### Options - -| Name | Type | Default | Description | -|:----------------|:-----------|:--------------------------------------------------------------------------------|:--------------------------------------| -| `--concurrency` | `intSlice` | `[1,2,4,8]` | Concurrency levels to test | -| `--duration` | `duration` | `30s` | Duration to run each concurrency test | -| `--json` | `bool` | | Output results in JSON format | -| `--prompt` | `string` | `Write a comprehensive 100 word summary on whales and their impact on society.` | Prompt to use for benchmarking | -| `--timeout` | `duration` | `5m0s` | Timeout for each individual request | - - - - diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_configure.md b/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_configure.md deleted file mode 100644 index 81fc1546bd5..00000000000 --- a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_configure.md +++ /dev/null @@ -1,14 +0,0 @@ -# docker model configure - - -Configure runtime options for a model - -### Options - -| Name | Type | Default | Description | -|:-----------------|:--------|:--------|:-------------------------| -| `--context-size` | `int64` | `-1` | context size (in tokens) | - - - - diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_df.md b/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_df.md deleted file mode 100644 index e6a4073670b..00000000000 --- a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_df.md +++ /dev/null @@ -1,8 +0,0 @@ -# docker model df - - -Show Docker Model Runner disk usage - - - - diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_inspect.md b/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_inspect.md deleted file mode 100644 index 7df01509381..00000000000 --- a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_inspect.md +++ /dev/null @@ -1,15 +0,0 @@ -# docker model inspect - - -Display detailed information on one model - -### Options - -| Name | Type | Default | Description | -|:-----------------|:-------|:--------|:-------------------------------| -| `--openai` | `bool` | | List model in an OpenAI format | -| `-r`, `--remote` | `bool` | | Show info for remote models | - - - - diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_install-runner.md b/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_install-runner.md deleted file mode 100644 index de40a502865..00000000000 --- a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_install-runner.md +++ /dev/null @@ -1,27 +0,0 @@ -# docker model install-runner - - -Install Docker Model Runner (Docker Engine only) - -### Options - -| Name | Type | Default | Description | -|:-----------------|:---------|:------------|:-------------------------------------------------------------------------------------------------------| -| `--backend` | `string` | | Specify backend (llama.cpp\|vllm\|diffusers). Default: llama.cpp | -| `--debug` | `bool` | | Enable debug logging | -| `--do-not-track` | `bool` | | Do not track models usage in Docker Model Runner | -| `--gpu` | `string` | `auto` | Specify GPU support (none\|auto\|cuda\|rocm\|musa\|cann) | -| `--host` | `string` | `127.0.0.1` | Host address to bind Docker Model Runner | -| `--port` | `uint16` | `0` | Docker container port for Docker Model Runner (default: 12434 for Docker Engine, 12435 for Cloud mode) | -| `--proxy-cert` | `string` | | Path to a CA certificate file for proxy SSL inspection | -| `--tls` | `bool` | | Enable TLS/HTTPS for Docker Model Runner API | -| `--tls-cert` | `string` | | Path to TLS certificate file (auto-generated if not provided) | -| `--tls-key` | `string` | | Path to TLS private key file (auto-generated if not provided) | -| `--tls-port` | `uint16` | `0` | TLS port for Docker Model Runner (default: 12444 for Docker Engine, 12445 for Cloud mode) | - - - - -## Description - - This command runs implicitly when a docker model command is executed. You can run this command explicitly to add a new configuration. diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_launch.md b/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_launch.md deleted file mode 100644 index 161e2a3a306..00000000000 --- a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_launch.md +++ /dev/null @@ -1,30 +0,0 @@ -# docker model launch - - -Launch an app configured to use Docker Model Runner. - -Without arguments, lists all supported apps. - -Supported apps: anythingllm, claude, codex, openclaw, opencode, openwebui - -Examples: - docker model launch - docker model launch opencode - docker model launch claude -- --help - docker model launch openwebui --port 3000 - docker model launch claude --config - -### Options - -| Name | Type | Default | Description | -|:------------|:---------|:--------|:------------------------------------------------| -| `--config` | `bool` | | Print configuration without launching | -| `--detach` | `bool` | | Run containerized app in background | -| `--dry-run` | `bool` | | Print what would be executed without running it | -| `--image` | `string` | | Override container image for containerized apps | -| `--model` | `string` | | Model to use (for opencode) | -| `--port` | `int` | `0` | Host port to expose (web UIs) | - - - - diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_list.md b/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_list.md deleted file mode 100644 index 24d260a5d86..00000000000 --- a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_list.md +++ /dev/null @@ -1,21 +0,0 @@ -# docker model list - - -List the models pulled to your local environment - -### Aliases - -`docker model list`, `docker model ls` - -### Options - -| Name | Type | Default | Description | -|:----------------|:---------|:--------|:-------------------------------------------------------| -| `--json` | `bool` | | List models in a JSON format | -| `--openai` | `bool` | | List models in an OpenAI format | -| `--openaiurl` | `string` | | OpenAI-compatible API endpoint URL to list models from | -| `-q`, `--quiet` | `bool` | | Only show model IDs | - - - - diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_logs.md b/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_logs.md deleted file mode 100644 index 8c5810924a1..00000000000 --- a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_logs.md +++ /dev/null @@ -1,15 +0,0 @@ -# docker model logs - - -Fetch the Docker Model Runner logs - -### Options - -| Name | Type | Default | Description | -|:-----------------|:-------|:--------|:----------------------------------------------| -| `-f`, `--follow` | `bool` | | View logs with real-time streaming | -| `--no-engines` | `bool` | | Exclude inference engine logs from the output | - - - - diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_package.md b/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_package.md deleted file mode 100644 index ade44149ba5..00000000000 --- a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_package.md +++ /dev/null @@ -1,59 +0,0 @@ -# docker model package - - -Package a model into a Docker Model OCI artifact. - -The model source must be one of: - --gguf A GGUF file (single file or first shard of a sharded model) - --safetensors-dir A directory containing .safetensors and configuration files - --dduf A .dduf (Diffusers Unified Format) archive - --from An existing packaged model reference - -By default, the packaged artifact is loaded into the local Model Runner content store. -Use --push to publish the model to a registry instead. - -MODEL specifies the target model reference (for example: myorg/llama3:8b). -When using --push, MODEL must be a registry-qualified reference. - -Packaging behavior: - - GGUF - --gguf must point to a .gguf file. - For sharded models, point to the first shard. All shards must: - • reside in the same directory - • follow an indexed naming convention (e.g. model-00001-of-00015.gguf) - All shards are automatically discovered and packaged together. - - Safetensors - --safetensors-dir must point to a directory containing .safetensors files - and required configuration files (e.g. model config, tokenizer files). - All files under the directory (including nested subdirectories) are - automatically discovered. Each file is packaged as a separate OCI layer. - - DDUF - --dduf must point to a .dduf archive file. - - Repackaging - --from repackages an existing model. You may override selected properties - such as --context-size to create a variant of the original model. - - Multimodal models - Use --mmproj to include a multimodal projector file. - -### Options - -| Name | Type | Default | Description | -|:--------------------|:--------------|:--------|:---------------------------------------------------------------------------------------| -| `--chat-template` | `string` | | absolute path to chat template file (must be Jinja format) | -| `--context-size` | `uint64` | `0` | context size in tokens | -| `--dduf` | `string` | | absolute path to DDUF archive file (Diffusers Unified Format) | -| `--from` | `string` | | reference to an existing model to repackage | -| `--gguf` | `string` | | absolute path to gguf file | -| `-l`, `--license` | `stringArray` | | absolute path to a license file | -| `--mmproj` | `string` | | absolute path to multimodal projector file | -| `--push` | `bool` | | push to registry (if not set, the model is loaded into the Model Runner content store) | -| `--safetensors-dir` | `string` | | absolute path to directory containing safetensors files and config | - - - - diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_ps.md b/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_ps.md deleted file mode 100644 index 15f5371553f..00000000000 --- a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_ps.md +++ /dev/null @@ -1,8 +0,0 @@ -# docker model ps - - -List running models - - - - diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_pull.md b/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_pull.md deleted file mode 100644 index 246cc59d78a..00000000000 --- a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_pull.md +++ /dev/null @@ -1,32 +0,0 @@ -# docker model pull - - -Pull a model from Docker Hub or HuggingFace to your local environment - - - - -## Description - -Pull a model to your local environment. Downloaded models also appear in the Docker Desktop Dashboard. - -## Examples - -### Pulling a model from Docker Hub - -```console -docker model pull ai/smollm2 -``` - -### Pulling from HuggingFace - -You can pull GGUF models directly from [Hugging Face](https://huggingface.co/models?library=gguf). - -**Note about quantization:** If no tag is specified, the command tries to pull the `Q4_K_M` version of the model. -If `Q4_K_M` doesn't exist, the command pulls the first GGUF found in the **Files** view of the model on HuggingFace. -To specify the quantization, provide it as a tag, for example: -`docker model pull hf.co/bartowski/Llama-3.2-1B-Instruct-GGUF:Q4_K_S` - -```console -docker model pull hf.co/bartowski/Llama-3.2-1B-Instruct-GGUF -``` diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_purge.md b/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_purge.md deleted file mode 100644 index 4fcc85c349d..00000000000 --- a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_purge.md +++ /dev/null @@ -1,14 +0,0 @@ -# docker model purge - - -Remove all models - -### Options - -| Name | Type | Default | Description | -|:----------------|:-------|:--------|:-----------------------------| -| `-f`, `--force` | `bool` | | Forcefully remove all models | - - - - diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_push.md b/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_push.md deleted file mode 100644 index 7b040fe0bf8..00000000000 --- a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_push.md +++ /dev/null @@ -1,13 +0,0 @@ -# docker model push - - -Push a model to Docker Hub or Hugging Face - - - - -### Example - -```console -docker model push / -``` diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_reinstall-runner.md b/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_reinstall-runner.md deleted file mode 100644 index 457b322e578..00000000000 --- a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_reinstall-runner.md +++ /dev/null @@ -1,27 +0,0 @@ -# docker model reinstall-runner - - -Reinstall Docker Model Runner (Docker Engine only) - -### Options - -| Name | Type | Default | Description | -|:-----------------|:---------|:------------|:-------------------------------------------------------------------------------------------------------| -| `--backend` | `string` | | Specify backend (llama.cpp\|vllm\|diffusers). Default: llama.cpp | -| `--debug` | `bool` | | Enable debug logging | -| `--do-not-track` | `bool` | | Do not track models usage in Docker Model Runner | -| `--gpu` | `string` | `auto` | Specify GPU support (none\|auto\|cuda\|rocm\|musa\|cann) | -| `--host` | `string` | `127.0.0.1` | Host address to bind Docker Model Runner | -| `--port` | `uint16` | `0` | Docker container port for Docker Model Runner (default: 12434 for Docker Engine, 12435 for Cloud mode) | -| `--proxy-cert` | `string` | | Path to a CA certificate file for proxy SSL inspection | -| `--tls` | `bool` | | Enable TLS/HTTPS for Docker Model Runner API | -| `--tls-cert` | `string` | | Path to TLS certificate file (auto-generated if not provided) | -| `--tls-key` | `string` | | Path to TLS private key file (auto-generated if not provided) | -| `--tls-port` | `uint16` | `0` | TLS port for Docker Model Runner (default: 12444 for Docker Engine, 12445 for Cloud mode) | - - - - -## Description - -This command removes the existing Docker Model Runner container and reinstalls it with the specified configuration. Models and images are preserved during reinstallation. diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_requests.md b/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_requests.md deleted file mode 100644 index 970dc3c3d6e..00000000000 --- a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_requests.md +++ /dev/null @@ -1,16 +0,0 @@ -# docker model requests - - -Fetch requests+responses from Docker Model Runner - -### Options - -| Name | Type | Default | Description | -|:---------------------|:---------|:--------|:---------------------------------------------------------------------------------| -| `-f`, `--follow` | `bool` | | Follow requests stream | -| `--include-existing` | `bool` | | Include existing requests when starting to follow (only available with --follow) | -| `--model` | `string` | | Specify the model to filter requests | - - - - diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_restart-runner.md b/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_restart-runner.md deleted file mode 100644 index 80565a8dfa1..00000000000 --- a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_restart-runner.md +++ /dev/null @@ -1,24 +0,0 @@ -# docker model restart-runner - - -Restart Docker Model Runner (Docker Engine only) - -### Options - -| Name | Type | Default | Description | -|:-----------------|:---------|:------------|:-------------------------------------------------------------------------------------------------------| -| `--debug` | `bool` | | Enable debug logging | -| `--do-not-track` | `bool` | | Do not track models usage in Docker Model Runner | -| `--gpu` | `string` | `auto` | Specify GPU support (none\|auto\|cuda\|rocm\|musa\|cann) | -| `--host` | `string` | `127.0.0.1` | Host address to bind Docker Model Runner | -| `--port` | `uint16` | `0` | Docker container port for Docker Model Runner (default: 12434 for Docker Engine, 12435 for Cloud mode) | -| `--proxy-cert` | `string` | | Path to a CA certificate file for proxy SSL inspection | - - - - -## Description - -This command restarts the Docker Model Runner without pulling container images. Use this command to restart the runner when you already have the required images locally. - -For the first-time setup or to ensure you have the latest images, use `docker model install-runner` instead. diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_rm.md b/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_rm.md deleted file mode 100644 index 6463903bd89..00000000000 --- a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_rm.md +++ /dev/null @@ -1,14 +0,0 @@ -# docker model rm - - -Remove local models downloaded from Docker Hub - -### Options - -| Name | Type | Default | Description | -|:----------------|:-------|:--------|:----------------------------| -| `-f`, `--force` | `bool` | | Forcefully remove the model | - - - - diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_run.md b/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_run.md deleted file mode 100644 index b6190d26a03..00000000000 --- a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_run.md +++ /dev/null @@ -1,61 +0,0 @@ -# docker model run - - -Run a model and interact with it using a submitted prompt or chat mode - -### Options - -| Name | Type | Default | Description | -|:-----------------|:---------|:--------|:-----------------------------------------------------| -| `--color` | `string` | `no` | Use colored output (auto\|yes\|no) | -| `--debug` | `bool` | | Enable debug logging | -| `-d`, `--detach` | `bool` | | Load the model in the background without interaction | -| `--openaiurl` | `string` | | OpenAI-compatible API endpoint URL to chat with | -| `--websearch` | `bool` | | Enable web search tool during chat | - - - - -## Description - -When you run a model, Docker calls an inference server API endpoint hosted by the Model Runner through Docker Desktop. The model stays in memory until another model is requested, or until a pre-defined inactivity timeout is reached (currently 5 minutes). - -You do not have to use Docker model run before interacting with a specific model from a host process or from within a container. Model Runner transparently loads the requested model on-demand, assuming it has been pulled and is locally available. - -You can also use chat mode in the Docker Desktop Dashboard when you select the model in the **Models** tab. - -## Examples - -### One-time prompt - -```console -docker model run ai/smollm2 "Hi" -``` - -Output: - -```console -Hello! How can I assist you today? -``` - -### Interactive chat - -```console -docker model run ai/smollm2 -``` - -Output: - -```console -> Hi -Hi there! It's SmolLM, AI assistant. How can I help you today? -> /bye -``` - -### Pre-load a model - -```console -docker model run --detach ai/smollm2 -``` - -This loads the model into memory without interaction, ensuring maximum performance for subsequent requests. diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_search.md b/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_search.md deleted file mode 100644 index b146e60c6d1..00000000000 --- a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_search.md +++ /dev/null @@ -1,27 +0,0 @@ -# docker model search - - -Search for models from Docker Hub (ai/ namespace) and HuggingFace. - -When no search term is provided, lists all available models. -When a search term is provided, filters models by name/description. - -Examples: - docker model search # List available models from Docker Hub - docker model search llama # Search for models containing "llama" - docker model search --source=all # Search both Docker Hub and HuggingFace - docker model search --source=huggingface # Only search HuggingFace - docker model search --limit=50 phi # Search with custom limit - docker model search --json llama # Output as JSON - -### Options - -| Name | Type | Default | Description | -|:----------------|:---------|:--------|:----------------------------------------------| -| `--json` | `bool` | | Output results as JSON | -| `-n`, `--limit` | `int` | `32` | Maximum number of results to show | -| `--source` | `string` | `all` | Source to search: all, dockerhub, huggingface | - - - - diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_show.md b/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_show.md deleted file mode 100644 index d8c37da522a..00000000000 --- a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_show.md +++ /dev/null @@ -1,14 +0,0 @@ -# docker model show - - -Display detailed information about a model in a human-readable format. - -### Options - -| Name | Type | Default | Description | -|:-----------------|:-------|:--------|:----------------------------| -| `-r`, `--remote` | `bool` | | Show info for remote models | - - - - diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_skills.md b/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_skills.md deleted file mode 100644 index 39ecc0ed721..00000000000 --- a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_skills.md +++ /dev/null @@ -1,32 +0,0 @@ -# docker model skills - - -Install Docker Model Runner skills for AI coding assistants. - -Skills are configuration files that help AI coding assistants understand -how to use Docker Model Runner effectively for local model inference. - -Supported targets: - --codex Install to ~/.codex/skills (OpenAI Codex CLI) - --claude Install to ~/.claude/skills (Claude Code) - --opencode Install to ~/.config/opencode/skills (OpenCode) - --dest Install to a custom directory - -Example: - docker model skills --claude - docker model skills --codex --claude - docker model skills --dest /path/to/skills - -### Options - -| Name | Type | Default | Description | -|:----------------|:---------|:--------|:--------------------------------------------------------| -| `--claude` | `bool` | | Install skills for Claude Code (~/.claude/skills) | -| `--codex` | `bool` | | Install skills for OpenAI Codex CLI (~/.codex/skills) | -| `--dest` | `string` | | Install skills to a custom directory | -| `-f`, `--force` | `bool` | | Overwrite existing skills without prompting | -| `--opencode` | `bool` | | Install skills for OpenCode (~/.config/opencode/skills) | - - - - diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_start-runner.md b/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_start-runner.md deleted file mode 100644 index 24cf2fe12f3..00000000000 --- a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_start-runner.md +++ /dev/null @@ -1,29 +0,0 @@ -# docker model start-runner - - -Start Docker Model Runner (Docker Engine only) - -### Options - -| Name | Type | Default | Description | -|:-----------------|:---------|:------------|:-------------------------------------------------------------------------------------------------------| -| `--backend` | `string` | | Specify backend (llama.cpp\|vllm\|diffusers). Default: llama.cpp | -| `--debug` | `bool` | | Enable debug logging | -| `--do-not-track` | `bool` | | Do not track models usage in Docker Model Runner | -| `--gpu` | `string` | `auto` | Specify GPU support (none\|auto\|cuda\|rocm\|musa\|cann) | -| `--host` | `string` | `127.0.0.1` | Host address to bind Docker Model Runner | -| `--port` | `uint16` | `0` | Docker container port for Docker Model Runner (default: 12434 for Docker Engine, 12435 for Cloud mode) | -| `--proxy-cert` | `string` | | Path to a CA certificate file for proxy SSL inspection | -| `--tls` | `bool` | | Enable TLS/HTTPS for Docker Model Runner API | -| `--tls-cert` | `string` | | Path to TLS certificate file (auto-generated if not provided) | -| `--tls-key` | `string` | | Path to TLS private key file (auto-generated if not provided) | -| `--tls-port` | `uint16` | `0` | TLS port for Docker Model Runner (default: 12444 for Docker Engine, 12445 for Cloud mode) | - - - - -## Description - -This command starts the Docker Model Runner without pulling container images. Use this command to start the runner when you already have the required images locally. - -For the first-time setup or to ensure you have the latest images, use `docker model install-runner` instead. diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_status.md b/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_status.md deleted file mode 100644 index baa630073db..00000000000 --- a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_status.md +++ /dev/null @@ -1,17 +0,0 @@ -# docker model status - - -Check if the Docker Model Runner is running - -### Options - -| Name | Type | Default | Description | -|:---------|:-------|:--------|:----------------------| -| `--json` | `bool` | | Format output in JSON | - - - - -## Description - -Check whether the Docker Model Runner is running and displays the current inference engine. diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_stop-runner.md b/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_stop-runner.md deleted file mode 100644 index 99a6b0cda60..00000000000 --- a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_stop-runner.md +++ /dev/null @@ -1,19 +0,0 @@ -# docker model stop-runner - - -Stop Docker Model Runner (Docker Engine only) - -### Options - -| Name | Type | Default | Description | -|:-----------|:-------|:--------|:----------------------------| -| `--models` | `bool` | | Remove model storage volume | - - - - -## Description - -This command stops the Docker Model Runner by removing the running containers, but preserves the container images on disk. Use this command when you want to temporarily stop the runner but plan to start it again later. - -To completely remove the runner including images, use `docker model uninstall-runner --images` instead. diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_tag.md b/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_tag.md deleted file mode 100644 index 3f1615e296f..00000000000 --- a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_tag.md +++ /dev/null @@ -1,11 +0,0 @@ -# docker model tag - - -Tag a model - - - - -## Description - -Specify a particular version or variant of the model. If no tag is provided, Docker defaults to `latest`. diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_uninstall-runner.md b/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_uninstall-runner.md deleted file mode 100644 index 8beb8744fd4..00000000000 --- a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_uninstall-runner.md +++ /dev/null @@ -1,16 +0,0 @@ -# docker model uninstall-runner - - -Uninstall Docker Model Runner (Docker Engine only) - -### Options - -| Name | Type | Default | Description | -|:------------|:---------|:--------|:----------------------------------------------------| -| `--backend` | `string` | | Uninstall a deferred backend (e.g. vllm, diffusers) | -| `--images` | `bool` | | Remove docker/model-runner images | -| `--models` | `bool` | | Remove model storage volume | - - - - diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_unload.md b/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_unload.md deleted file mode 100644 index 70d7f8f2884..00000000000 --- a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_unload.md +++ /dev/null @@ -1,15 +0,0 @@ -# docker model unload - - -Unload running models - -### Options - -| Name | Type | Default | Description | -|:------------|:---------|:--------|:---------------------------| -| `--all` | `bool` | | Unload all running models | -| `--backend` | `string` | | Optional backend to target | - - - - diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_version.md b/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_version.md deleted file mode 100644 index eb32c61fd97..00000000000 --- a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/model_version.md +++ /dev/null @@ -1,8 +0,0 @@ -# docker model version - - -Show the Docker Model Runner version - - - - diff --git a/_vendor/modules.txt b/_vendor/modules.txt index e83e2b91df1..861f8566726 100644 --- a/_vendor/modules.txt +++ b/_vendor/modules.txt @@ -2,5 +2,3 @@ # github.com/moby/buildkit v0.29.0 # github.com/docker/buildx v0.33.0 # github.com/docker/cli v29.4.0+incompatible -# github.com/docker/compose/v5 v5.1.2 -# github.com/docker/model-runner v1.1.28 diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose.yaml b/data/cli/compose/docker_compose.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose.yaml rename to data/cli/compose/docker_compose.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_alpha.yaml b/data/cli/compose/docker_compose_alpha.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_alpha.yaml rename to data/cli/compose/docker_compose_alpha.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_alpha_dry-run.yaml b/data/cli/compose/docker_compose_alpha_dry-run.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_alpha_dry-run.yaml rename to data/cli/compose/docker_compose_alpha_dry-run.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_alpha_generate.yaml b/data/cli/compose/docker_compose_alpha_generate.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_alpha_generate.yaml rename to data/cli/compose/docker_compose_alpha_generate.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_alpha_publish.yaml b/data/cli/compose/docker_compose_alpha_publish.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_alpha_publish.yaml rename to data/cli/compose/docker_compose_alpha_publish.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_alpha_scale.yaml b/data/cli/compose/docker_compose_alpha_scale.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_alpha_scale.yaml rename to data/cli/compose/docker_compose_alpha_scale.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_alpha_viz.yaml b/data/cli/compose/docker_compose_alpha_viz.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_alpha_viz.yaml rename to data/cli/compose/docker_compose_alpha_viz.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_alpha_watch.yaml b/data/cli/compose/docker_compose_alpha_watch.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_alpha_watch.yaml rename to data/cli/compose/docker_compose_alpha_watch.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_attach.yaml b/data/cli/compose/docker_compose_attach.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_attach.yaml rename to data/cli/compose/docker_compose_attach.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_bridge.yaml b/data/cli/compose/docker_compose_bridge.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_bridge.yaml rename to data/cli/compose/docker_compose_bridge.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_bridge_convert.yaml b/data/cli/compose/docker_compose_bridge_convert.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_bridge_convert.yaml rename to data/cli/compose/docker_compose_bridge_convert.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_bridge_transformations.yaml b/data/cli/compose/docker_compose_bridge_transformations.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_bridge_transformations.yaml rename to data/cli/compose/docker_compose_bridge_transformations.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_bridge_transformations_create.yaml b/data/cli/compose/docker_compose_bridge_transformations_create.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_bridge_transformations_create.yaml rename to data/cli/compose/docker_compose_bridge_transformations_create.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_bridge_transformations_list.yaml b/data/cli/compose/docker_compose_bridge_transformations_list.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_bridge_transformations_list.yaml rename to data/cli/compose/docker_compose_bridge_transformations_list.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_build.yaml b/data/cli/compose/docker_compose_build.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_build.yaml rename to data/cli/compose/docker_compose_build.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_commit.yaml b/data/cli/compose/docker_compose_commit.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_commit.yaml rename to data/cli/compose/docker_compose_commit.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_config.yaml b/data/cli/compose/docker_compose_config.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_config.yaml rename to data/cli/compose/docker_compose_config.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_convert.yaml b/data/cli/compose/docker_compose_convert.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_convert.yaml rename to data/cli/compose/docker_compose_convert.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_cp.yaml b/data/cli/compose/docker_compose_cp.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_cp.yaml rename to data/cli/compose/docker_compose_cp.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_create.yaml b/data/cli/compose/docker_compose_create.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_create.yaml rename to data/cli/compose/docker_compose_create.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_down.yaml b/data/cli/compose/docker_compose_down.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_down.yaml rename to data/cli/compose/docker_compose_down.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_events.yaml b/data/cli/compose/docker_compose_events.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_events.yaml rename to data/cli/compose/docker_compose_events.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_exec.yaml b/data/cli/compose/docker_compose_exec.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_exec.yaml rename to data/cli/compose/docker_compose_exec.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_export.yaml b/data/cli/compose/docker_compose_export.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_export.yaml rename to data/cli/compose/docker_compose_export.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_images.yaml b/data/cli/compose/docker_compose_images.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_images.yaml rename to data/cli/compose/docker_compose_images.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_kill.yaml b/data/cli/compose/docker_compose_kill.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_kill.yaml rename to data/cli/compose/docker_compose_kill.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_logs.yaml b/data/cli/compose/docker_compose_logs.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_logs.yaml rename to data/cli/compose/docker_compose_logs.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_ls.yaml b/data/cli/compose/docker_compose_ls.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_ls.yaml rename to data/cli/compose/docker_compose_ls.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_pause.yaml b/data/cli/compose/docker_compose_pause.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_pause.yaml rename to data/cli/compose/docker_compose_pause.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_port.yaml b/data/cli/compose/docker_compose_port.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_port.yaml rename to data/cli/compose/docker_compose_port.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_ps.yaml b/data/cli/compose/docker_compose_ps.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_ps.yaml rename to data/cli/compose/docker_compose_ps.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_publish.yaml b/data/cli/compose/docker_compose_publish.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_publish.yaml rename to data/cli/compose/docker_compose_publish.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_pull.yaml b/data/cli/compose/docker_compose_pull.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_pull.yaml rename to data/cli/compose/docker_compose_pull.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_push.yaml b/data/cli/compose/docker_compose_push.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_push.yaml rename to data/cli/compose/docker_compose_push.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_restart.yaml b/data/cli/compose/docker_compose_restart.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_restart.yaml rename to data/cli/compose/docker_compose_restart.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_rm.yaml b/data/cli/compose/docker_compose_rm.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_rm.yaml rename to data/cli/compose/docker_compose_rm.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_run.yaml b/data/cli/compose/docker_compose_run.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_run.yaml rename to data/cli/compose/docker_compose_run.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_scale.yaml b/data/cli/compose/docker_compose_scale.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_scale.yaml rename to data/cli/compose/docker_compose_scale.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_start.yaml b/data/cli/compose/docker_compose_start.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_start.yaml rename to data/cli/compose/docker_compose_start.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_stats.yaml b/data/cli/compose/docker_compose_stats.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_stats.yaml rename to data/cli/compose/docker_compose_stats.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_stop.yaml b/data/cli/compose/docker_compose_stop.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_stop.yaml rename to data/cli/compose/docker_compose_stop.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_top.yaml b/data/cli/compose/docker_compose_top.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_top.yaml rename to data/cli/compose/docker_compose_top.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_unpause.yaml b/data/cli/compose/docker_compose_unpause.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_unpause.yaml rename to data/cli/compose/docker_compose_unpause.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_up.yaml b/data/cli/compose/docker_compose_up.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_up.yaml rename to data/cli/compose/docker_compose_up.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_version.yaml b/data/cli/compose/docker_compose_version.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_version.yaml rename to data/cli/compose/docker_compose_version.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_volumes.yaml b/data/cli/compose/docker_compose_volumes.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_volumes.yaml rename to data/cli/compose/docker_compose_volumes.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_wait.yaml b/data/cli/compose/docker_compose_wait.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_wait.yaml rename to data/cli/compose/docker_compose_wait.yaml diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_watch.yaml b/data/cli/compose/docker_compose_watch.yaml similarity index 100% rename from _vendor/github.com/docker/compose/v5/docs/reference/docker_compose_watch.yaml rename to data/cli/compose/docker_compose_watch.yaml diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model.yaml b/data/cli/model/docker_model.yaml similarity index 100% rename from _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model.yaml rename to data/cli/model/docker_model.yaml diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_bench.yaml b/data/cli/model/docker_model_bench.yaml similarity index 100% rename from _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_bench.yaml rename to data/cli/model/docker_model_bench.yaml diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_compose.yaml b/data/cli/model/docker_model_compose.yaml similarity index 100% rename from _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_compose.yaml rename to data/cli/model/docker_model_compose.yaml diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_compose_down.yaml b/data/cli/model/docker_model_compose_down.yaml similarity index 100% rename from _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_compose_down.yaml rename to data/cli/model/docker_model_compose_down.yaml diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_compose_metadata.yaml b/data/cli/model/docker_model_compose_metadata.yaml similarity index 100% rename from _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_compose_metadata.yaml rename to data/cli/model/docker_model_compose_metadata.yaml diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_compose_up.yaml b/data/cli/model/docker_model_compose_up.yaml similarity index 100% rename from _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_compose_up.yaml rename to data/cli/model/docker_model_compose_up.yaml diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_configure.yaml b/data/cli/model/docker_model_configure.yaml similarity index 100% rename from _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_configure.yaml rename to data/cli/model/docker_model_configure.yaml diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_configure_show.yaml b/data/cli/model/docker_model_configure_show.yaml similarity index 100% rename from _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_configure_show.yaml rename to data/cli/model/docker_model_configure_show.yaml diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_df.yaml b/data/cli/model/docker_model_df.yaml similarity index 100% rename from _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_df.yaml rename to data/cli/model/docker_model_df.yaml diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_inspect.yaml b/data/cli/model/docker_model_inspect.yaml similarity index 100% rename from _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_inspect.yaml rename to data/cli/model/docker_model_inspect.yaml diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_install-runner.yaml b/data/cli/model/docker_model_install-runner.yaml similarity index 100% rename from _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_install-runner.yaml rename to data/cli/model/docker_model_install-runner.yaml diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_launch.yaml b/data/cli/model/docker_model_launch.yaml similarity index 100% rename from _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_launch.yaml rename to data/cli/model/docker_model_launch.yaml diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_list.yaml b/data/cli/model/docker_model_list.yaml similarity index 100% rename from _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_list.yaml rename to data/cli/model/docker_model_list.yaml diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_logs.yaml b/data/cli/model/docker_model_logs.yaml similarity index 100% rename from _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_logs.yaml rename to data/cli/model/docker_model_logs.yaml diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_package.yaml b/data/cli/model/docker_model_package.yaml similarity index 100% rename from _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_package.yaml rename to data/cli/model/docker_model_package.yaml diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_ps.yaml b/data/cli/model/docker_model_ps.yaml similarity index 100% rename from _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_ps.yaml rename to data/cli/model/docker_model_ps.yaml diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_pull.yaml b/data/cli/model/docker_model_pull.yaml similarity index 100% rename from _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_pull.yaml rename to data/cli/model/docker_model_pull.yaml diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_purge.yaml b/data/cli/model/docker_model_purge.yaml similarity index 100% rename from _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_purge.yaml rename to data/cli/model/docker_model_purge.yaml diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_push.yaml b/data/cli/model/docker_model_push.yaml similarity index 100% rename from _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_push.yaml rename to data/cli/model/docker_model_push.yaml diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_reinstall-runner.yaml b/data/cli/model/docker_model_reinstall-runner.yaml similarity index 100% rename from _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_reinstall-runner.yaml rename to data/cli/model/docker_model_reinstall-runner.yaml diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_requests.yaml b/data/cli/model/docker_model_requests.yaml similarity index 100% rename from _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_requests.yaml rename to data/cli/model/docker_model_requests.yaml diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_restart-runner.yaml b/data/cli/model/docker_model_restart-runner.yaml similarity index 100% rename from _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_restart-runner.yaml rename to data/cli/model/docker_model_restart-runner.yaml diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_rm.yaml b/data/cli/model/docker_model_rm.yaml similarity index 100% rename from _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_rm.yaml rename to data/cli/model/docker_model_rm.yaml diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_run.yaml b/data/cli/model/docker_model_run.yaml similarity index 100% rename from _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_run.yaml rename to data/cli/model/docker_model_run.yaml diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_search.yaml b/data/cli/model/docker_model_search.yaml similarity index 100% rename from _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_search.yaml rename to data/cli/model/docker_model_search.yaml diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_show.yaml b/data/cli/model/docker_model_show.yaml similarity index 100% rename from _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_show.yaml rename to data/cli/model/docker_model_show.yaml diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_skills.yaml b/data/cli/model/docker_model_skills.yaml similarity index 100% rename from _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_skills.yaml rename to data/cli/model/docker_model_skills.yaml diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_start-runner.yaml b/data/cli/model/docker_model_start-runner.yaml similarity index 100% rename from _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_start-runner.yaml rename to data/cli/model/docker_model_start-runner.yaml diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_status.yaml b/data/cli/model/docker_model_status.yaml similarity index 100% rename from _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_status.yaml rename to data/cli/model/docker_model_status.yaml diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_stop-runner.yaml b/data/cli/model/docker_model_stop-runner.yaml similarity index 100% rename from _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_stop-runner.yaml rename to data/cli/model/docker_model_stop-runner.yaml diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_tag.yaml b/data/cli/model/docker_model_tag.yaml similarity index 100% rename from _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_tag.yaml rename to data/cli/model/docker_model_tag.yaml diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_uninstall-runner.yaml b/data/cli/model/docker_model_uninstall-runner.yaml similarity index 100% rename from _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_uninstall-runner.yaml rename to data/cli/model/docker_model_uninstall-runner.yaml diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_unload.yaml b/data/cli/model/docker_model_unload.yaml similarity index 100% rename from _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_unload.yaml rename to data/cli/model/docker_model_unload.yaml diff --git a/_vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_version.yaml b/data/cli/model/docker_model_version.yaml similarity index 100% rename from _vendor/github.com/docker/model-runner/cmd/cli/docs/reference/docker_model_version.yaml rename to data/cli/model/docker_model_version.yaml diff --git a/go.mod b/go.mod index 5444fe2f5df..7b45dabccef 100644 --- a/go.mod +++ b/go.mod @@ -10,8 +10,6 @@ go 1.26.0 require ( github.com/docker/buildx v0.33.0 github.com/docker/cli v29.4.0+incompatible - github.com/docker/compose/v5 v5.1.2 - github.com/docker/model-runner v1.1.28 github.com/moby/buildkit v0.29.0 github.com/moby/moby/api v1.54.1 ) @@ -19,8 +17,6 @@ require ( tool ( github.com/docker/buildx github.com/docker/cli - github.com/docker/compose/v5 - github.com/docker/model-runner github.com/docker/scout-cli github.com/moby/buildkit github.com/moby/moby/api diff --git a/go.sum b/go.sum index d1ac59891a4..d70b7d3927b 100644 --- a/go.sum +++ b/go.sum @@ -86,14 +86,6 @@ github.com/docker/cli v29.3.1+incompatible h1:M04FDj2TRehDacrosh7Vlkgc7AuQoWloQk github.com/docker/cli v29.3.1+incompatible/go.mod h1:JLrzqnKDaYBop7H2jaqPtU4hHvMKP+vjCwu2uszcLI8= github.com/docker/cli v29.4.0+incompatible h1:+IjXULMetlvWJiuSI0Nbor36lcJ5BTcVpUmB21KBoVM= github.com/docker/cli v29.4.0+incompatible/go.mod h1:JLrzqnKDaYBop7H2jaqPtU4hHvMKP+vjCwu2uszcLI8= -github.com/docker/compose/v5 v5.0.0 h1:J2uMCzJ/5xLcoIVVXvMmPe6HBzVQpmJThKa7Qk7Xldc= -github.com/docker/compose/v5 v5.0.0/go.mod h1:BurapGv8zmYnsbSmlpCz5EU2Pi3YFV/PjeUnoFpcw64= -github.com/docker/compose/v5 v5.0.1 h1:5yCjDJbwUqcuI+6WNFHNWz2/3vyBDsNnfe8LlFjyxEc= -github.com/docker/compose/v5 v5.0.1/go.mod h1:vuKBtnRuvsVIlYHzdPkF3SToljqR+pFJseO5lDBuF18= -github.com/docker/compose/v5 v5.0.2 h1:OTBsvKsim2rVNUBrb9pP5byiGG5trTt+uO3qr6WIQYo= -github.com/docker/compose/v5 v5.0.2/go.mod h1:MbI7iBpjcgTN27JC4cYYR1mmfmaWEqEgqKKfbEGFK1c= -github.com/docker/compose/v5 v5.1.2 h1:HxtfGZA0DESw/+hvrNJDjM8VKmCond7OkmgVJCHku48= -github.com/docker/compose/v5 v5.1.2/go.mod h1:JJ2H+lRSugOH50/zxCbkBwN8jU91qDtRCp7gEHWZdgo= github.com/docker/distribution v2.8.3+incompatible h1:AtKxIZ36LoNK51+Z6RpzLpddBirtxJnzDrHLEKxTAYk= github.com/docker/distribution v2.8.3+incompatible/go.mod h1:J2gT2udsDAN96Uj4KfcMRqY0/ypR+oyYUYmja8H+y+w= github.com/docker/docker v28.5.2+incompatible h1:DBX0Y0zAjZbSrm1uzOkdr1onVghKaftjlSWt4AFexzM= @@ -108,20 +100,6 @@ github.com/docker/go-units v0.5.0 h1:69rxXcBk27SvSaaxTtLh/8llcHD8vYHT7WSdRZ/jvr4 github.com/docker/go-units v0.5.0/go.mod h1:fgPhTUdO+D/Jk86RDLlptpiXQzgHJF7gydDDbaIK4Dk= github.com/docker/mcp-gateway v0.22.0 h1:l4t+HRNHxR7Jn545KDeXaeiEEhkCDBeWMTyuCaXVH7A= github.com/docker/mcp-gateway v0.22.0/go.mod h1:4sGoRoMeu8lj4a/HbAd/jdxXjMNVMegNnjCqmhsED+I= -github.com/docker/model-runner v1.0.3 h1:04qSAOsFvxOYIejMOc2XGug+WQSTax0RO0OMA7DkwTU= -github.com/docker/model-runner v1.0.3/go.mod h1:qRIuXMeZ5dnL4A9e/+BUtQOSZAS0PBxUkLN51XYpLOE= -github.com/docker/model-runner v1.1.8 h1:dAdrvz5oHxnWToM732NOtbwK5hBSUQpX87JQ6AQPDUE= -github.com/docker/model-runner v1.1.8/go.mod h1:BUkuBVgWQhMfN6rY+1KesorT9lwG2D0xCNY8Co9xKCI= -github.com/docker/model-runner v1.1.9-0.20260303081710-59280ed7abd5 h1:oY1RUGY7sDj5DUjqlxWAIJR4olBp3298iL8mWYFjXFg= -github.com/docker/model-runner v1.1.9-0.20260303081710-59280ed7abd5/go.mod h1:S1ttvsnofZx35unrXuzhcbZ7fWOpNhLPawhNrRMHp+c= -github.com/docker/model-runner v1.1.24 h1:SmlaZOlXJ5YC5ouxgwBj1qkfFSdgIw4BSFqnA3N86m8= -github.com/docker/model-runner v1.1.24/go.mod h1:Sz8p8xoQiRW4Kbx8u7zAGynPESSJc/EZrPjHi+Ghtoo= -github.com/docker/model-runner v1.1.28 h1:SrGTSP8X0v3z5m1jEzZu5n3OnOJbDZom6UMmrSZ3iQE= -github.com/docker/model-runner v1.1.28/go.mod h1:AVBP5brJ8TkQD94cLKMVTn5jkrV1o8/b20hkeL8WTsE= -github.com/docker/model-runner/cmd/cli v1.0.3 h1:oycm6fHwhFBNM47Y2Ka7nUSsrbSG3FL7NMShjTRuxak= -github.com/docker/model-runner/cmd/cli v1.0.3/go.mod h1:86LCLsk93vuevYRDKoBxwGusyGlW+UnKCnbXJ7m6Zjo= -github.com/docker/model-runner/pkg/go-containerregistry v0.0.0-20251121150728-6951a2a36575 h1:N2yLWYSZFTVLkLTh8ux1Z0Nug/F78pXsl2KDtbWhe+Y= -github.com/docker/model-runner/pkg/go-containerregistry v0.0.0-20251121150728-6951a2a36575/go.mod h1:gbdiY0X8gr0J88OfUuRD29JXCWT9jgHzPmrqTlO15BM= github.com/elastic/go-sysinfo v1.15.4 h1:A3zQcunCxik14MgXu39cXFXcIw2sFXZ0zL886eyiv1Q= github.com/elastic/go-sysinfo v1.15.4/go.mod h1:ZBVXmqS368dOn/jvijV/zHLfakWTYHBZPk3G244lHrU= github.com/elastic/go-windows v1.0.2 h1:yoLLsAsV5cfg9FLhZ9EXZ2n2sQFKeDYrHenkcivY4vI= diff --git a/hugo.yaml b/hugo.yaml index 7dc5e6b50d7..22012012c19 100644 --- a/hugo.yaml +++ b/hugo.yaml @@ -363,16 +363,5 @@ module: - source: docs/reference/dockerd.md target: content/reference/cli/dockerd.md - # Compose - - path: github.com/docker/compose/v5 - mounts: - - source: docs/reference - target: data/cli/compose - files: ["*.yaml"] - - # Model CLI - - path: github.com/docker/model-runner - mounts: - - source: cmd/cli/docs/reference - target: data/cli/model - files: ["*.yaml"] + # Compose and Model Runner CLI reference YAML is synced to data/cli/ + # by the sync-upstream-cli workflow. No Hugo module mounts needed. From 910eeb0436c88f4d223cd278a55cf878a582dc92 Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Wed, 15 Apr 2026 16:13:47 +0200 Subject: [PATCH 4/6] =?UTF-8?q?ci:=20simplify=20workflow=20=E2=80=94=20sta?= =?UTF-8?q?tic=20matrix,=20no=20prepare=20job?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Replace JavaScript-based dynamic matrix with a static YAML matrix. Version resolution is a simple `gh api` call in the sync job itself. Dispatch filtering uses a job-level `if` condition. Co-Authored-By: Claude Opus 4.6 (1M context) --- .github/workflows/sync-upstream-cli.yml | 115 +++++++----------------- 1 file changed, 34 insertions(+), 81 deletions(-) diff --git a/.github/workflows/sync-upstream-cli.yml b/.github/workflows/sync-upstream-cli.yml index 09131b43521..8b6f2e487d0 100644 --- a/.github/workflows/sync-upstream-cli.yml +++ b/.github/workflows/sync-upstream-cli.yml @@ -4,9 +4,7 @@ # For each configured upstream repo, runs its docs bake target via git context # to generate YAML, copies it to data/cli//, and opens a PR. # -# Upstream contract: a bake target that outputs *.yaml CLI reference files. -# Target names and output paths are configured per-repo in the `repos` array below. -# Long-term goal: standardize on a common `docs-release` target name across repos. +# To add a new repo: add an entry to the matrix and to the workflow_dispatch options. name: sync-upstream-cli @@ -17,7 +15,7 @@ on: workflow_dispatch: inputs: repo: - description: "Upstream repo (e.g., docker/buildx)" + description: "Upstream repo" required: true type: choice options: @@ -25,7 +23,7 @@ on: - docker/compose - docker/model-runner version: - description: "Git tag to sync (e.g., v0.33.0). Leave empty to use latest release." + description: "Git tag (e.g., v0.33.0). Leave empty for latest release." required: false type: string @@ -38,82 +36,31 @@ env: SETUP_BUILDKIT_IMAGE: "moby/buildkit:latest" jobs: - prepare: - runs-on: ubuntu-24.04 - outputs: - matrix: ${{ steps.matrix.outputs.result }} - steps: - - name: Build matrix - id: matrix - uses: actions/github-script@v7 - with: - script: | - // Each upstream repo with its bake configuration. - // - target: the bake target name that generates CLI YAML - // - files: bake file path (empty = root docker-bake.hcl) - // - yaml_glob: where the YAML ends up in the bake output - const repos = [ - { - repo: "docker/buildx", - folder: "buildx", - target: "update-docs", - files: "", - yaml_glob: "out/reference", - }, - { - repo: "docker/compose", - folder: "compose", - target: "docs-update", - files: "", - yaml_glob: "out/reference", - }, - { - repo: "docker/model-runner", - folder: "model", - target: "update-docs", - files: "cmd/cli/docker-bake.hcl", - yaml_glob: ".", - }, - ]; - - const inputRepo = context.payload.inputs?.repo || ""; - const inputVersion = context.payload.inputs?.version || ""; - - let matrix = []; - for (const r of repos) { - if (inputRepo && r.repo !== inputRepo) continue; - - let version = inputVersion; - if (!version) { - try { - const { data: release } = await github.rest.repos.getLatestRelease({ - owner: r.repo.split("/")[0], - repo: r.repo.split("/")[1], - }); - version = release.tag_name; - } catch (e) { - core.warning(`Could not fetch latest release for ${r.repo}: ${e.message}`); - continue; - } - } - - matrix.push({ ...r, version }); - } - - core.info(JSON.stringify(matrix, null, 2)); - return matrix; - sync: - needs: prepare - if: ${{ fromJSON(needs.prepare.outputs.matrix).length > 0 }} runs-on: ubuntu-24.04 + if: ${{ !inputs.repo || inputs.repo == matrix.repo }} strategy: fail-fast: false matrix: - include: ${{ fromJSON(needs.prepare.outputs.matrix) }} + include: + - { repo: docker/buildx, folder: buildx, target: update-docs, files: "", yaml_glob: "out/reference" } + - { repo: docker/compose, folder: compose, target: docs-update, files: "", yaml_glob: "out/reference" } + - { repo: docker/model-runner, folder: model, target: update-docs, files: "cmd/cli/docker-bake.hcl", yaml_glob: "." } env: BRANCH: "bot/sync-${{ matrix.folder }}-cli" steps: + - name: Resolve version + id: version + env: + GH_TOKEN: ${{ github.token }} + run: | + if [ -n "${{ inputs.version }}" ]; then + echo "tag=${{ inputs.version }}" >> "$GITHUB_OUTPUT" + else + TAG=$(gh api "repos/${{ matrix.repo }}/releases/latest" --jq '.tag_name') + echo "tag=$TAG" >> "$GITHUB_OUTPUT" + fi + - name: Checkout docker/docs uses: actions/checkout@v5 with: @@ -123,14 +70,15 @@ jobs: id: check env: GH_TOKEN: ${{ github.token }} + VERSION: ${{ steps.version.outputs.tag }} run: | EXISTING=$(gh pr list --state all \ - --search "cli(${{ matrix.folder }}): sync docs ${{ matrix.version }} in:title" \ + --search "cli(${{ matrix.folder }}): sync docs $VERSION in:title" \ --json state --jq '.[0].state // empty') if [ "$EXISTING" = "MERGED" ] || [ "$EXISTING" = "CLOSED" ]; then echo "skip=true" >> "$GITHUB_OUTPUT" - echo "Already synced ${{ matrix.repo }} ${{ matrix.version }}" >> "$GITHUB_STEP_SUMMARY" + echo "Already synced ${{ matrix.repo }} $VERSION" >> "$GITHUB_STEP_SUMMARY" else echo "skip=false" >> "$GITHUB_OUTPUT" fi @@ -146,7 +94,7 @@ jobs: if: steps.check.outputs.skip != 'true' uses: docker/bake-action@v7 with: - source: "${{ github.server_url }}/${{ matrix.repo }}.git#${{ matrix.version }}" + source: "${{ github.server_url }}/${{ matrix.repo }}.git#${{ steps.version.outputs.tag }}" files: ${{ matrix.files || '' }} targets: ${{ matrix.target }} provenance: false @@ -165,11 +113,13 @@ jobs: - name: Check for changes if: steps.check.outputs.skip != 'true' id: diff + env: + VERSION: ${{ steps.version.outputs.tag }} run: | git add "data/cli/${{ matrix.folder }}/" if git diff --cached --quiet; then echo "changes=false" >> "$GITHUB_OUTPUT" - echo "No changes detected for ${{ matrix.repo }} ${{ matrix.version }}" >> "$GITHUB_STEP_SUMMARY" + echo "No changes for ${{ matrix.repo }} $VERSION" >> "$GITHUB_STEP_SUMMARY" else echo "changes=true" >> "$GITHUB_OUTPUT" echo '```' >> "$GITHUB_STEP_SUMMARY" @@ -179,19 +129,22 @@ jobs: - name: Commit and push if: steps.check.outputs.skip != 'true' && steps.diff.outputs.changes == 'true' + env: + VERSION: ${{ steps.version.outputs.tag }} run: | git config user.name "github-actions[bot]" git config user.email "41898282+github-actions[bot]@users.noreply.github.com" git checkout -b "$BRANCH" - git commit -m "cli(${{ matrix.folder }}): sync docs ${{ matrix.version }}" + git commit -m "cli(${{ matrix.folder }}): sync docs $VERSION" git push -u origin "$BRANCH" --force - name: Create or update PR if: steps.check.outputs.skip != 'true' && steps.diff.outputs.changes == 'true' env: GH_TOKEN: ${{ github.token }} + VERSION: ${{ steps.version.outputs.tag }} run: | - TITLE="cli(${{ matrix.folder }}): sync docs ${{ matrix.version }}" + TITLE="cli(${{ matrix.folder }}): sync docs $VERSION" EXISTING=$(gh pr list --state open \ --head "$BRANCH" --json url --jq '.[0].url // empty') @@ -204,8 +157,8 @@ jobs: | | | |---|---| | **Tool** | \`${{ matrix.folder }}\` | - | **Version** | \`${{ matrix.version }}\` | - | **Source** | [${{ matrix.repo }}@${{ matrix.version }}](${{ github.server_url }}/${{ matrix.repo }}/tree/${{ matrix.version }}) | + | **Version** | \`$VERSION\` | + | **Source** | [${{ matrix.repo }}@$VERSION](${{ github.server_url }}/${{ matrix.repo }}/tree/$VERSION) | EOF ) From a79027bd48ad7cae77238e912dcb108b8b09f5df Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Wed, 15 Apr 2026 16:17:23 +0200 Subject: [PATCH 5/6] ci: format matrix for readability Co-Authored-By: Claude Opus 4.6 (1M context) --- .github/workflows/sync-upstream-cli.yml | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/.github/workflows/sync-upstream-cli.yml b/.github/workflows/sync-upstream-cli.yml index 8b6f2e487d0..8c76d3570df 100644 --- a/.github/workflows/sync-upstream-cli.yml +++ b/.github/workflows/sync-upstream-cli.yml @@ -43,9 +43,21 @@ jobs: fail-fast: false matrix: include: - - { repo: docker/buildx, folder: buildx, target: update-docs, files: "", yaml_glob: "out/reference" } - - { repo: docker/compose, folder: compose, target: docs-update, files: "", yaml_glob: "out/reference" } - - { repo: docker/model-runner, folder: model, target: update-docs, files: "cmd/cli/docker-bake.hcl", yaml_glob: "." } + - repo: docker/buildx + folder: buildx + target: update-docs + yaml_glob: out/reference + + - repo: docker/compose + folder: compose + target: docs-update + yaml_glob: out/reference + + - repo: docker/model-runner + folder: model + target: update-docs + files: cmd/cli/docker-bake.hcl + yaml_glob: "." env: BRANCH: "bot/sync-${{ matrix.folder }}-cli" steps: From b1a264dd1d924fde09265fadf3a46d244b31d5cc Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Wed, 15 Apr 2026 16:20:34 +0200 Subject: [PATCH 6/6] ci: use peter-evans/create-pull-request for PR creation Replaces manual git commit/push/gh-pr-create with a single action that handles commit, branch, push, and PR create/update. Co-Authored-By: Claude Opus 4.6 (1M context) --- .github/workflows/sync-upstream-cli.yml | 77 ++++++------------------- 1 file changed, 17 insertions(+), 60 deletions(-) diff --git a/.github/workflows/sync-upstream-cli.yml b/.github/workflows/sync-upstream-cli.yml index 8c76d3570df..364df7dffee 100644 --- a/.github/workflows/sync-upstream-cli.yml +++ b/.github/workflows/sync-upstream-cli.yml @@ -58,8 +58,6 @@ jobs: target: update-docs files: cmd/cli/docker-bake.hcl yaml_glob: "." - env: - BRANCH: "bot/sync-${{ matrix.folder }}-cli" steps: - name: Resolve version id: version @@ -122,62 +120,21 @@ jobs: rm -f "data/cli/${{ matrix.folder }}"/*.yaml cp /tmp/docs-release/${{ matrix.yaml_glob }}/*.yaml "data/cli/${{ matrix.folder }}/" - - name: Check for changes + - name: Create pull request if: steps.check.outputs.skip != 'true' - id: diff - env: - VERSION: ${{ steps.version.outputs.tag }} - run: | - git add "data/cli/${{ matrix.folder }}/" - if git diff --cached --quiet; then - echo "changes=false" >> "$GITHUB_OUTPUT" - echo "No changes for ${{ matrix.repo }} $VERSION" >> "$GITHUB_STEP_SUMMARY" - else - echo "changes=true" >> "$GITHUB_OUTPUT" - echo '```' >> "$GITHUB_STEP_SUMMARY" - git diff --cached --stat >> "$GITHUB_STEP_SUMMARY" - echo '```' >> "$GITHUB_STEP_SUMMARY" - fi - - - name: Commit and push - if: steps.check.outputs.skip != 'true' && steps.diff.outputs.changes == 'true' - env: - VERSION: ${{ steps.version.outputs.tag }} - run: | - git config user.name "github-actions[bot]" - git config user.email "41898282+github-actions[bot]@users.noreply.github.com" - git checkout -b "$BRANCH" - git commit -m "cli(${{ matrix.folder }}): sync docs $VERSION" - git push -u origin "$BRANCH" --force - - - name: Create or update PR - if: steps.check.outputs.skip != 'true' && steps.diff.outputs.changes == 'true' - env: - GH_TOKEN: ${{ github.token }} - VERSION: ${{ steps.version.outputs.tag }} - run: | - TITLE="cli(${{ matrix.folder }}): sync docs $VERSION" - - EXISTING=$(gh pr list --state open \ - --head "$BRANCH" --json url --jq '.[0].url // empty') - - BODY=$(cat <> "$GITHUB_STEP_SUMMARY" - gh pr edit "$EXISTING" --title "$TITLE" --body "$BODY" - else - echo "Creating new PR" >> "$GITHUB_STEP_SUMMARY" - gh pr create --title "$TITLE" --base main --head "$BRANCH" --body "$BODY" - fi + uses: peter-evans/create-pull-request@v7 + with: + branch: bot/sync-${{ matrix.folder }}-cli + title: "cli(${{ matrix.folder }}): sync docs ${{ steps.version.outputs.tag }}" + commit-message: "cli(${{ matrix.folder }}): sync docs ${{ steps.version.outputs.tag }}" + body: | + ## Summary + + Automated sync of CLI reference docs. + + | | | + |---|---| + | **Tool** | `${{ matrix.folder }}` | + | **Version** | `${{ steps.version.outputs.tag }}` | + | **Source** | [${{ matrix.repo }}@${{ steps.version.outputs.tag }}](${{ github.server_url }}/${{ matrix.repo }}/tree/${{ steps.version.outputs.tag }}) | + delete-branch: true