Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions bazel/container_structure_test.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,7 @@ _attrs = {
doc = "See https://github.com/GoogleContainerTools/container-structure-test#running-file-tests-without-docker",
),
"platform": attr.string(
default = "linux/amd64",
doc = "Set platform if host is multi-platform capable (default \"linux/amd64\")",
doc = "Set platform if host is multi-platform capable",
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

To improve clarity for users of this rule, it would be helpful to mention what the default behavior is when platform is not specified. The underlying container-structure-test tool defaults to the host's architecture (linux/GOARCH), so mentioning examples for different architectures would be beneficial.

Suggested change
doc = "Set platform if host is multi-platform capable",
doc = "Set platform if host is multi-platform capable. If not set, it defaults to the host's platform, e.g., 'linux/amd64' or 'linux/arm64'."

),
"_runfiles": attr.label(default = "@bazel_tools//tools/bash/runfiles"),
"_windows_constraint": attr.label(default = "@platforms//os:windows"),
Expand Down