From 9af53c9350ced9c7f839b917b6f71503db41fdd4 Mon Sep 17 00:00:00 2001 From: Dmitriy Kalinin Date: Wed, 11 Dec 2019 11:57:03 -0500 Subject: [PATCH] rearrange builders sections in configuration doc --- docs/config.md | 21 +++++++++------------ 1 file changed, 9 insertions(+), 12 deletions(-) diff --git a/docs/config.md b/docs/config.md index c262ffe8..954effe6 100644 --- a/docs/config.md +++ b/docs/config.md @@ -17,7 +17,7 @@ sources: path: src/ ``` -For Docker (all options shown): +#### Docker ```yaml --- @@ -27,6 +27,7 @@ sources: - image: image1 path: src/ docker: + # all options shown; none are required build: target: "some-target" pull: true @@ -35,7 +36,13 @@ sources: rawOptions: ["--squash"] ``` -For pack: +- `docker.build.target` (string): Set the target build stage to build (no default) +- `docker.build.pull` (bool): Always attempt to pull a newer version of the image (default is false) +- `docker.build.noCache` (bool): Do not use cache when building the image (default is false) +- `docker.build.file` (string): Name of the Dockerfile (default is Dockerfile) +- `docker.build.rawOptions` ([]string): Refer to https://docs.docker.com/engine/reference/commandline/build/ for all available options + +#### Pack ```yaml --- @@ -49,16 +56,6 @@ sources: builder: cloudfoundry/cnb:bionic ``` -#### Docker - -- `docker.build.target` (string): Set the target build stage to build (no default) -- `docker.build.pull` (bool): Always attempt to pull a newer version of the image (default is false) -- `docker.build.noCache` (bool): Do not use cache when building the image (default is false) -- `docker.build.file` (string): Name of the Dockerfile (default is Dockerfile) -- `docker.build.rawOptions` ([]string): Refer to https://docs.docker.com/engine/reference/commandline/build/ for all available options - -#### Pack - - `pack.build.builder` (string): Set builder image (required) - `pack.build.buildpacks` ([]string): Set list of buildpacks to be used (no default) - `pack.build.clearCache` (bool): Clear cache before building image (default is false)