Skip to content

docs: compose logs: add more links for flag descriptions#13833

Merged
glours merged 1 commit into
docker:mainfrom
thaJeztah:more_links
Jun 10, 2026
Merged

docs: compose logs: add more links for flag descriptions#13833
glours merged 1 commit into
docker:mainfrom
thaJeztah:more_links

Conversation

@thaJeztah

Copy link
Copy Markdown
Member

follow-up to 7eeb7de, adding more links now that the CLI reference for docker logs has anchors for them.

What I did

Related issue

(not mandatory) A picture of a cute animal, if possible in relation to what you did

Copilot AI review requested due to automatic review settings June 9, 2026 15:46
@thaJeztah thaJeztah requested a review from a team as a code owner June 9, 2026 15:46
@thaJeztah thaJeztah requested review from glours and ndeloof June 9, 2026 15:46
@thaJeztah

Copy link
Copy Markdown
Member Author

Actions are failing because some are not pinned;

Getting action download info
Error: The actions actions/checkout@v5, actions/download-artifact@v5, actions/github-script@v8, docker/setup-buildx-action@v4, and docker/bake-action@v7 are not allowed in docker/compose because all actions must be pinned to a full-length commit SHA.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the docker compose logs reference documentation to link individual flag entries (and their short forms where applicable) directly to the corresponding anchored sections in the upstream docker container logs CLI reference, now that those anchors exist.

Changes:

  • Add per-flag details_url anchors for follow, since, tail, and timestamps in the Compose docs YAML.
  • Update the generated compose_logs.md options table so flags link to the anchored upstream docker container logs sections.
  • Add/update annotation.ExternalURL annotations for the corresponding flags in cmd/compose/logs.go to match the anchored links.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
docs/reference/docker_compose_logs.yaml Adds anchored details_url entries for additional logs flags.
docs/reference/compose_logs.md Updates generated options table links to point at anchored upstream references (incl. short flags).
cmd/compose/logs.go Adds/updates annotation.ExternalURL for logs flags to use anchored upstream references.

@docker-agent docker-agent Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Assessment: 🟢 APPROVE

This PR adds hyperlink annotations (ExternalURL) to four flags (--follow, --timestamps, --tail, and the existing --since/--until) in cmd/compose/logs.go, with corresponding updates to the generated Markdown and YAML reference docs.

All added URL anchors (#follow, #since, #timestamps, #tail) are consistent across the three changed files. No logic errors, formatting issues, or inconsistencies were found in the added lines.

@glours

glours commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

@thaJeztah I will open a PR to fix the unpinned versions in workflows right now

@codecov

codecov Bot commented Jun 9, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@thaJeztah

Copy link
Copy Markdown
Member Author

Opened a PR to fix CI;

@glours

glours commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

@thaJeztah already merged, you can rebase your PR

@thaJeztah

Copy link
Copy Markdown
Member Author

Oh! Missed your earlier comment 🙈 will rebase!

follow-up to 7eeb7de, adding more
links now that the CLI reference for docker logs has anchors for them.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@thaJeztah

Copy link
Copy Markdown
Member Author

Hm... networking issues, or is it changes on our side blocking requests?

#17 [build-base 2/2] RUN --mount=type=cache,target=/go/pkg/mod     --mount=type=cache,target=/root/.cache/go-build     go mod download
#17 18.45 go: github.com/moby/moby/api@v1.54.2: read "https://proxy.golang.org/github.com/moby/moby/api/@v/v1.54.2.zip": stream error: stream ID 747; INTERNAL_ERROR; received from peer
#17 ERROR: process "/bin/sh -c go mod download" did not complete successfully: exit code: 1
------
 > [build-base 2/2] RUN --mount=type=cache,target=/go/pkg/mod     --mount=type=cache,target=/root/.cache/go-build     go mod download:
18.45 go: github.com/moby/moby/api@v1.54.2: read "https://proxy.golang.org/github.com/moby/moby/api/@v/v1.54.2.zip": stream error: stream ID 747; INTERNAL_ERROR; received from peer
------
Dockerfile:52

@glours glours merged commit 39ee1d0 into docker:main Jun 10, 2026
78 of 80 checks passed
@thaJeztah thaJeztah deleted the more_links branch June 10, 2026 08:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants