actions/build-container-installer
1
0
Fork 0
mirror of https://github.com/JasonN3/build-container-installer.git synced 2025-12-25 02:47:56 +01:00
Code Releases Activity

doc: Fix up readme (#19)

Browse source
This commit is contained in:
Jason N 2024-02-28 12:03:00 -05:00 • committed by GitHub
parent a69d22bc73
commit 1a5a5b4295
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 47 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

75
README.md
View file

@ -3,33 +3,24 @@
# Bulid Container Installer Action # Bulid Container Installer Action
This action is used to generate an ISO for installing OSTrees stored in a container. This utilizes the anaconda command `ostreecontainer` This action is used to generate an ISO for installing OSTrees stored in a container. This utilizes the anaconda command `ostreecontainer`
## Makefile ## Usage
A Makefile is provided for ease of use. There are separate targets for each file generated, however `make` can be used to generate the final image and `make clean` can be used to clean up the workspace. The resulting ISO will be stored in the `build` directory. This action is designed to be called from a GitHub workflow using the following format
```yaml
See [Customizing](#customizing) for information about customizing the image that gets created. - name: Build ISO
uses: jasonn3/build-container-installer/v1.0.0
## Container with:
A container with the necessary tools already installed is provided at `ghcr.io/jasonn3/build-container-installer:latest` arch: ${{ env.ARCH}}
image_name: ${{ env.IMAGE_NAME}}
To use the container file, run `docker run --privileged --volume .:/build-container-installer/build ghcr.io/jasonn3/build-container-installer:latest`. image_repo: ${{ env.IMAGE_REPO}}
version: ${{ env.VERSION }}
This will create an ISO with the baked in defaults of the container image. variant: ${{ env.VARIANT }}
action_version: v1.0.0
See [Customizing](#customizing) for information about customizing the image that gets created. The variable can either be defined as environment variables or as command arguments.
Examples:
Building an ISO to install Fedora 38
```bash
docker run --rm --privileged --volume .:/build-container-installer/build -e VERSION=38 -e IMAGE_NAME=base -e IMAGE_TAG=38 -e VARIANT=Server ghcr.io/jasonn3/build-container-installer:latest
``` ```
Building an ISO to install Fedora 39 See [Customizing](#customizing) for information about customizing the ISO that gets created using `with`
```bash
docker run --rm --privileged --volume .:/build-container-installer/build -e VERSION=39 -e IMAGE_NAME=base -e IMAGE_TAG=39 -e VARIANT=Server ghcr.io/jasonn3/build-container-installer:latest
```
## Customizing ## Customizing
The following variables can be used to customize the create image. The following variables can be used to customize the created ISO.
| Variable | Description | Default Value | | Variable | Description | Default Value |
| ----------------- | -------------------------------------------------------- | ------------------------------ | | ----------------- | -------------------------------------------------------- | ------------------------------ |
@ -45,15 +36,43 @@ The following variables can be used to customize the create image.
Available options for VARIANT can be found by running `dnf provides system-release`. Available options for VARIANT can be found by running `dnf provides system-release`.
Variant will be the third item in the package name. Example: `fedora-release-kinoite-39-34.noarch` will be kinoite Variant will be the third item in the package name. Example: `fedora-release-kinoite-39-34.noarch` will be kinoite
## VSCode Dev Container ## Development
### Makefile
The Makefile contains all of the commands that are run in the action. There are separate targets for each file generated, however `make` can be used to generate the final image and `make clean` can be used to clean up the workspace. The resulting ISO will be stored in the `build` directory.
`make install-deps` can be used to install the necessary packages
See [Customizing](#customizing) for information about customizing the ISO that gets created.
### Container
A container with `make install-deps` already run is provided at `ghcr.io/jasonn3/build-container-installer:latest`
To use the container file, run `docker run --privileged --volume .:/build-container-installer/build ghcr.io/jasonn3/build-container-installer:latest`.
This will create an ISO with the baked in defaults of the container image.
See [Customizing](#customizing) for information about customizing the ISO that gets created. The variable can either be defined as environment variables.
Examples:
Building an ISO to install Fedora 38
```bash
docker run --rm --privileged --volume .:/build-container-installer/build -e VERSION=38 -e IMAGE_NAME=base -e IMAGE_TAG=38 -e VARIANT=Server ghcr.io/jasonn3/build-container-installer:latest
```
Building an ISO to install Fedora 39
```bash
docker run --rm --privileged --volume .:/build-container-installer/build -e VERSION=39 -e IMAGE_NAME=base -e IMAGE_TAG=39 -e VARIANT=Server ghcr.io/jasonn3/build-container-installer:latest
```
### VSCode Dev Container
There is a dev container configuration provided for development. By default it will use the existing container image available at `ghcr.io/jasonn3/build-container-installer:latest`, however, you can have it build a new image by editing `.devcontainer/devcontainer.json` and replacing `image` with `build`. `Ctrl+/` can be used to comment and uncomment blocks of code within VSCode. There is a dev container configuration provided for development. By default it will use the existing container image available at `ghcr.io/jasonn3/build-container-installer:latest`, however, you can have it build a new image by editing `.devcontainer/devcontainer.json` and replacing `image` with `build`. `Ctrl+/` can be used to comment and uncomment blocks of code within VSCode.
The code from VSCode will be available at `/workspaces/build-container-installer` once the container has started. The code from VSCode will be available at `/workspaces/build-container-installer` once the container has started.
Privileged is required for access to loop devices for lorax. Privileged is required for access to loop devices for lorax.
Use existing image Use existing container image:
```json ```
{ {
"name": "Existing Dockerfile", "name": "Existing Dockerfile",
// "build": { // "build": {
@ -70,8 +89,8 @@ Use existing image
} }
``` ```
Build a new image Build a new container image:
```json ```
{ {
"name": "Existing Dockerfile", "name": "Existing Dockerfile",
"build": { "build": {