Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme with new cleanup #85

Merged
merged 2 commits into from
Mar 24, 2021
Merged
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
161 changes: 79 additions & 82 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,88 +65,85 @@ jobs:
## Arguments

```
Options:
-h, --help
Display this help and exit.

Repository / Data
-r, --repository <REPOSITORY>
Set git repository to load data from.
-b, --branch <BRANCH>
Set git branch for repository.
-t, --target <PATH_TO_BUILD>
Set local folder or path inside repository for build.

Version/Image handling
-v, --version <VERSION>
Overwrite version/tag of build.
-i, --image <IMAGE_NAME>
Overwrite image name of build / support {arch}.
--release <VERSION>
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 <TAG>
Use a custom tag for the build cache.
-d, --docker-hub <DOCKER_REPOSITORY>
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 <VERSION>
Build based on the build.json
--builder-wheels <PYTHON_TAG>
Build the wheels builder for Home Assistant.
--base <VERSION>
Build our base images.
--base-python <VERSION=ALPINE>
Build our base python images.
--base-raspbian <VERSION>
Build our base raspbian images.
--base-ubuntu <VERSION>
Build our base ubuntu images.
--base-debian <VERSION>
Build our base debian images.
--homeassisant-landingpage
Build the landingpage for machines.
--homeassistant-machine <VERSION=ALL,X,Y>
Build the machine based image for a release.
Options:
-h, --help
Display this help and exit.

Repository / Data
-r, --repository <REPOSITORY>
Set git repository to load data from.
-b, --branch <BRANCH>
Set git branch for repository.
-t, --target <PATH_TO_BUILD>
Set local folder or path inside repository for build.

Version/Image handling
-v, --version <VERSION>
Overwrite version/tag of build.
-i, --image <IMAGE_NAME>
Overwrite image name of build / support {arch}.
--release <VERSION>
Additional version information like for base images.
--release-tag
Use this as main tag.
--version-from <VERSION>
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 <TAG>
Use a custom tag for the build cache.
-d, --docker-hub <DOCKER_REPOSITORY>
Set or overwrite the docker repository.
--docker-hub-check
Check if the version already exists before starting the build.
--docker-user <USER>
Username to login into docker with
--docker-password <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 <VERSION>
Build based on the build.json
--base <VERSION>
Build our base images.
--homeassisant-landingpage
Build the landingpage for machines.
--homeassistant-machine <VERSION=ALL,X,Y>
Build the machine based image for a release.

Security:
--with-codenotary <USER> <PASSWORD> <OWNER>
Enable signing images with CodeNotary. Need set follow env:
--validate-from <ORG|signer>
Validate the FROM image which is used to build the image.
--validate-cache <ORG|signer>
Validate the cache image which is used to build the image.
```

## Local installation
Expand Down