diff --git a/README.md b/README.md index 2d42f84..b7c0c39 100644 --- a/README.md +++ b/README.md @@ -65,88 +65,85 @@ jobs: ## Arguments ``` -Options: --h, --help - Display this help and exit. - -Repository / Data - -r, --repository - Set git repository to load data from. - -b, --branch - Set git branch for repository. - -t, --target - Set local folder or path inside repository for build. - -Version/Image handling - -v, --version - Overwrite version/tag of build. - -i, --image - Overwrite image name of build / support {arch}. - --release - Additional version information like for base images. - --release-tag - Use this as main tag. - -Architecture - --armhf - Build for arm v6. - --armv7 - Build for arm v7. - --amd64 - Build for intel/amd 64bit. - --aarch64 - Build for arm 64bit. - --i386 - Build for intel/amd 32bit. - --all - Build all architecture. - -Build handling - --test - Disable push to dockerhub. - --no-latest - Do not tag images as latest. - --no-cache - Disable cache for the build (from latest). - --self-cache - Use same tag as cache tag instead latest. - --cache-tag - Use a custom tag for the build cache. - -d, --docker-hub - Set or overwrite the docker repository. - --docker-hub-check - Check if the version already exists before starting the build. - --docker-user - Username to login into docker with - --docker-password - Password to login into docker with - --no-crossbuild-cleanup - Don't cleanup the crosscompile feature (for multiple builds) - - Use the host docker socket if mapped into container: - /var/run/docker.sock - -Internals: - --addon - Default on. Run all things for an addon build. - --generic - Build based on the build.json - --builder-wheels - Build the wheels builder for Home Assistant. - --base - Build our base images. - --base-python - Build our base python images. - --base-raspbian - Build our base raspbian images. - --base-ubuntu - Build our base ubuntu images. - --base-debian - Build our base debian images. - --homeassisant-landingpage - Build the landingpage for machines. - --homeassistant-machine - Build the machine based image for a release. + Options: + -h, --help + Display this help and exit. + + Repository / Data + -r, --repository + Set git repository to load data from. + -b, --branch + Set git branch for repository. + -t, --target + Set local folder or path inside repository for build. + + Version/Image handling + -v, --version + Overwrite version/tag of build. + -i, --image + Overwrite image name of build / support {arch}. + --release + Additional version information like for base images. + --release-tag + Use this as main tag. + --version-from + Use this to set build_from tag if not specified. + + Architecture + --armhf + Build for arm v6. + --armv7 + Build for arm v7. + --amd64 + Build for intel/amd 64bit. + --aarch64 + Build for arm 64bit. + --i386 + Build for intel/amd 32bit. + --all + Build all architecture. + + Build handling + --test + Disable push to dockerhub. + --no-latest + Do not tag images as latest. + --no-cache + Disable cache for the build (from latest). + --self-cache + Use same tag as cache tag instead latest. + --cache-tag + Use a custom tag for the build cache. + -d, --docker-hub + Set or overwrite the docker repository. + --docker-hub-check + Check if the version already exists before starting the build. + --docker-user + Username to login into docker with + --docker-password + Password to login into docker with + Use the host docker socket if mapped into container: + /var/run/docker.sock + + Internals: + --addon + Default on. Run all things for an addon build. + --generic + Build based on the build.json + --base + Build our base images. + --homeassisant-landingpage + Build the landingpage for machines. + --homeassistant-machine + Build the machine based image for a release. + + Security: + --with-codenotary + Enable signing images with CodeNotary. Need set follow env: + --validate-from + Validate the FROM image which is used to build the image. + --validate-cache + Validate the cache image which is used to build the image. ``` ## Local installation