checks: add check for constant in from platform flag #5140
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fc7a908 to
989d184
Compare
tonistiigi
reviewed
Jul 9, 2024
| @@ -315,6 +315,7 @@ func toDispatchState(ctx context.Context, dt []byte, opt ConvertOpt) (*dispatchS | |||
| platMatch, err := shlex.ProcessWordWithMatches(v, platEnv) | |||
| reportUnusedFromArgs(metaArgsKeys(optMetaArgs), platMatch.Unmatched, st.Location, lint) | |||
| reportRedundantTargetPlatform(st.Platform, platMatch, st.Location, platEnv, lint) | |||
| reportFromConstDisallowed(st.Name, platMatch, st.Location, lint) | |||
There was a problem hiding this comment.
reportConstPlatformDisallowed
| ```dockerfile | ||
| FROM --platform=${BUILDPLATFORM} alpine AS base | ||
| RUN apk add --no-cache git | ||
| ``` |
There was a problem hiding this comment.
Add this multi-stage example as good example:
FROM --platform=linux/amd64 alpine:3.20 AS build_amd64
...
FROM --platform=linux/arm64 alpine:3.19 AS build_arm64
...
FROM build_${TARGETARCH} AS build
...
...
| ## Output | ||
|
|
||
| ```text | ||
| FROM --platform=linux/amd64 should not use a constant value |
There was a problem hiding this comment.
"FROM --platform flag should not ... " ?
|
|
||
| * Omit `FROM --platform` in the Dockerfile and use the `--platform` argument on the command line. | ||
| * Use `$BUILDPLATFORM` or some other combination of variables for the `--platform` argument. | ||
| * Stage name should include the platform, OS, or architecture name. |
There was a problem hiding this comment.
"Stage name should include the platform, OS, or architecture name to indicate that it only contains platform-specific instructions"
c48d349 to
c644927
Compare
This linter rule triggers if a constant value has been used in the `FROM --platform` flag and the stage name doesn't contain the OS or architecture mentioned. Signed-off-by: Jonathan A. Sternberg <jonathan.sternberg@docker.com>
c644927 to
58753e8
Compare
|
Test failure seems to be unrelated: |
|
@jsternberg covered by #5142 |
tonistiigi
approved these changes
Jul 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This linter rule triggers if a constant value has been used in the
FROM --platformflag and the stage name doesn't contain the OS orarchitecture mentioned.
Fixes #5131.