Support building from Dockerfile.in templates in devcontainer.json using configurable preprocessing tool#1233
Open
Mathiyarasy wants to merge 10 commits into
Open
Conversation
…ockerfilePreprocessor in devcontainer.json
This file contains hidden or 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
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.
Fixes: #1223
Issue Description: Podman supports building from Dockerfile.in files by using the system cpp preprocessor to generate a valid Dockerfile before the build runs. Dev Containers do not currently support this workflow. The existing CLI reads the Dockerfile directly, identifies the final FROM stage, and then extends it with features. When the input is a Dockerfile.in that has not been preprocessed yet, the CLI may not see a resolved FROM instruction, which causes the build flow to fail.
Solution:
Dockerfile.in-style templates before the existing Dockerfile build flow runs.dockerfilePreprocessorconfiguration indevcontainer.jsonto support building fromDockerfile.in-style templates.cppso it can also support generator-style tools such ascmake,meson, andautoconf.Preprocessing contract
tool: required. Specifies the preprocessor tool to invoke. The CLI assumes the tool is already installed on the host and only invokes it.args: optional. Arguments passed directly to the configured tool.generatedDockerfilePath: required. Specifies the path, relative to the Dockerfile.in directory, where the preprocessing tool will produce the final Dockerfile. After preprocessing, the CLI validates that this file exists and then promotes it into the CLI-owned output path used by the rest of the build flow.Validation rules
toolis required.generatedDockerfilePathis required.Example
{ "build": { "dockerfile": "Dockerfile.in" }, "dockerfilePreprocessor": { "tool": "cpp", "args": [ "-P", "./Dockerfile.in", "Dockerfile" ], "generatedDockerfilePath": "Dockerfile" }, "features": { "ghcr.io/devcontainers/features/github-cli:1": { "version": "latest" } } }Test coverage
Adds unit and integration coverage for: