-
Notifications
You must be signed in to change notification settings - Fork 62
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update container build README to mention release.Dockerfile
- Loading branch information
Showing
3 changed files
with
23 additions
and
7 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,6 +5,7 @@ on: | |
push: | ||
branches: | ||
- main | ||
paths-ignore: docs/ | ||
|
||
env: | ||
REGISTRY: ghcr.io | ||
|
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,26 @@ | ||
# Containerized Kit CLI | ||
|
||
The Dockerfile in this directory can be used for building a containerized version of the Kit CLI. To build this image manually, run the following command from the root of this repository: | ||
```bash | ||
docker build -t kit-cli:latest -f build/dockerfiles/Dockerfile . | ||
The Dockerfiles in this directory can be used for building a containerized version of the Kit CLI. The default entrypoint | ||
for these image is invoking the `kit` CLI, allowing for quickly running Kit commands without needing to install the CLI: | ||
``` | ||
docker run --rm ghcr.io/jozu-ai/kit:latest version | ||
``` | ||
|
||
The default entrypoint for this image is invoking the `kit` CLI, allowing for quickly running Kit commands without needing to install the CLI: | ||
## Release build | ||
The dockerfile named `release.Dockerfile` will build a container that includes a specified release of the Kit CLI, downloaded | ||
from GitHub releases. To build this container to include Kit version `vX.Y.Z`, use the following command | ||
```bash | ||
docker build -t kit-cli:my-tag -f build/dockerfiles/release.Dockerfile --build-arg KIT_VERSION=vX.Y.Z . | ||
``` | ||
docker run --rm ghcr.io/jozu-ai/kit:latest version | ||
Note, the `KIT_VERSION` build arg is required. | ||
|
||
|
||
## Offline build | ||
The dockerfile named `Dockerfile` will build a container by compiling the Kit CLI from local sources. To build this image | ||
manually, run the following command from the root of this repository: | ||
|
||
```bash | ||
docker build -t kit-cli:next -f build/dockerfiles/Dockerfile . | ||
``` | ||
By default, this container will set the Kit CLI version inside the container to `next`. To override this, you can specify | ||
the build arg `KIT_VERSION`. |