Skip to content

docs: improve README.md #11

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

Merged
merged 1 commit into from
Mar 26, 2024
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
63 changes: 35 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,47 @@
# image-tools
# image-tools v0.0.5

Version: 0.0.5
Commandline tools to manage Stackable container images available at https://github.com/stackabletech/docker-images

## Installation
This repository (and the installable package) contain two tools:

We recommend to use [pipx](https://pypa.github.io/pipx/):
* `bake` : build and publish product images.
* `check-container` : run RedHat preflight checks on container images.

pipx install image-tools-stackabletech
## Usage examples

But you can also use `pip`:
Run either `bake` or `check-container` with `--help` to get an overview of the accepted flags and their functionality.
Below are some common usage examples:

# from PyPI
pip install image-tools-stackabletech
# from GitHub
pip install git+https://github.com/stackabletech/image-tools.git@main
```shell
# Build images of the hello-world containers
bake -p hello-world -i 0.0.0-dev

## Description
# Build only one version [0.37.2] of OPA
bake -p opa=0.37.2 -i 0.0.0-dev

Tools to manage Stackable container images available at https://github.com/stackabletech/docker-images
# Build half of all versions defined for OPA
bake -p opa -i 0.0.0-dev --shard-count 2 --shard-index 0

Following tools are installed:
# Build the other half of all versions defined for OPA
bake -p opa -i 0.0.0-dev --shard-count 2 --shard-index 1
```

* `bake` : build and publish product images.
* `check-container` : run RedHat preflight checks on container images.

## Examples
## Installation

# Build images of the hello-world containers
bake -p hello-world -i 0.0.0-dev
We recommend to use [pipx](https://pypa.github.io/pipx/):

# Build only one version [0.37.2] of OPA
bake -p opa=0.37.2 -i 0.0.0-dev
```shell
pipx install image-tools-stackabletech
```

# Build half of all versions defined for OPA
bake -p opa -i 0.0.0-dev --shard-count 2 --shard-index 0
But you can also use `pip`:

# Build the other half of all versions defined for OPA
bake -p opa -i 0.0.0-dev --shard-count 2 --shard-index 1
```shell
# from PyPI
pip install image-tools-stackabletech
# from GitHub
pip install git+https://github.com/stackabletech/image-tools.git@main
```

## Release a new version

Expand All @@ -49,6 +54,8 @@ Update the CHANGELOG.
Commit and tag.
Build and publish:

rm -rf dist/
python -m build --sdist --wheel .
twine upload dist/*
```shell
rm -rf dist/
python -m build --sdist --wheel .
twine upload dist/*
```