Skip to content
Merged
Show file tree
Hide file tree
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
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,7 @@ or `pipx:`
pipx install git+https://github.com/xcp-ng/xcp-ng-build-env
```

After this, two new commands will be available: `xcp-ng-dev-env-create` and
`xcp-ng-dev`.
After this, a new command will be available: `xcp-ng-dev`.

If you want to develop the package and try the changes as you develop
the package, or prefer updating the version from a git repo rather
Expand All @@ -63,6 +62,8 @@ Depending on how you installed:
* with `pipx`: run the same command, with `--force`
* editable with `git`: just update your git working tree

Then download the latest image with `docker pull ghcr.io/xcp-ng/xcp-ng-build-env:8.3` or `podman pull ghcr.io/xcp-ng/xcp-ng-build-env:8.3`.

## Completion

### Bash
Expand All @@ -79,15 +80,19 @@ To install the completion, run `register-python-argcomplete --shell fish xcp-ng-

## Building the container image(s)

> [!NOTE]
> The images are typically downloaded from ghcr.io for regular usage.
> Unless you're working on this project, you usually don't need to build the container images yourself.

You need one container image per target version of XCP-ng.

Clone this repository (outside any container), then use `xcp-ng-dev-env-create` to
generate the images for the wanted releases of XCP-ng.
Clone this repository (outside any container), then use `./container/build.sh` to
generate the image. Adapt the version to the wanted release of XCP-ng.
Note that Docker and Podman store container images separately.

```
Usage: xcp-ng-dev-env-create {version_of_XCP_ng}
... where {version_of_XCP_ng} is a 'x.y' version such as 8.0.
Usage: ./container/build.sh [--platform PF] <version>
... where <version> is a 'x.y' version such as 8.0.
```

## Using the container
Expand Down
2 changes: 1 addition & 1 deletion container/build.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env bash
set -e

SELF_NAME="xcp-ng-dev-env-create"
SELF_NAME=$0

die() {
echo >&2
Expand Down