diff --git a/docs/Development/Container.md b/docs/Development/Container.md index f75b9f4..e976bac 100644 --- a/docs/Development/Container.md +++ b/docs/Development/Container.md @@ -6,7 +6,7 @@ To use the container file, run `podman run --privileged --volume .:/build-contai This will create an ISO with the baked in defaults of the container image. The resulting file will be called `deploy.iso` -See [Customizing](#customizing) for information about customizing the ISO that gets created. The variable can either be defined as environment variables. All variable should be specified CAPITALIZED. +See [Customizing](#customizing) for information about customizing the ISO that gets created. The variables can be defined as environment variables or command arguments. All variables should be specified CAPITALIZED. Examples: Building an ISO to install Fedora 39 diff --git a/docs/Development/VSCode.md b/docs/Development/VSCode.md index 661727e..9e9de1b 100644 --- a/docs/Development/VSCode.md +++ b/docs/Development/VSCode.md @@ -7,17 +7,18 @@ The code from VSCode will be available at `/workspaces/build-container-installer Privileged is required for access to loop devices for lorax. ## Use existing container image: -``` + +```diff { - "name": "Existing Dockerfile", -// "build": { -// "context": "..", -// "dockerfile": "../Containerfile", -// "args": { -// "version": "39" -// } -// }, - "image": "ghcr.io/jasonn3/build-container-installer:latest", + "name": "Existing Image", +- "build": { +- "context": "..", +- "dockerfile": "../Containerfile", +- "args": { +- "version": "39" +- } +- }, ++ "image": "ghcr.io/jasonn3/build-container-installer:latest", "overrideCommand": true, "shutdownAction": "stopContainer", "privileged": true @@ -25,19 +26,21 @@ Privileged is required for access to loop devices for lorax. ``` ## Build a new container image: -``` + +```diff { - "name": "Existing Dockerfile", - "build": { - "context": "..", - "dockerfile": "../Containerfile", - "args": { - "version": "39" - } - }, - //"image": "ghcr.io/jasonn3/build-container-installer:latest", + "name": "New Image", ++ "build": { ++ "context": "..", ++ "dockerfile": "../Containerfile", ++ "args": { ++ "version": "39" ++ } ++ }, +- "image": "ghcr.io/jasonn3/build-container-installer:latest", "overrideCommand": true, "shutdownAction": "stopContainer", "privileged": true } ``` + diff --git a/docs/Examples/Adding-Flatpaks.md b/docs/Examples/Adding-Flatpaks.md index 1d04f65..b82d916 100644 --- a/docs/Examples/Adding-Flatpaks.md +++ b/docs/Examples/Adding-Flatpaks.md @@ -4,8 +4,10 @@ - [Using a directory](#using-a-directory) ## Directly using refs + Action: Specify the following in your workflow: + ```yaml - name: Build ISO uses: jasonn3/build-container-installer@main @@ -15,8 +17,10 @@ Specify the following in your workflow: flatpak_remote_url: https://flathub.org/repo/flathub.flatpakrepo flatpak_remote_refs: app/org.videolan.VLC/x86_64/stable runtime/org.kde.Platform/x86_64/5.15-23.08 ``` + Podman: Run the following command: + ```bash podman run --privileged --volume ./:/github/workspace/ ghcr.io/jasonn3/build-container-installer:main \ FLATPAK_REMOTE_NAME=flathub \ @@ -25,14 +29,18 @@ podman run --privileged --volume ./:/github/workspace/ ghcr.io/jasonn3/build-con ``` --- ## Using a directory + Action: 1. Create a directory within your GitHub repo named flatpak_refs 1. Create a file within flatpak_refs with the following content + ``` app/org.videolan.VLC/x86_64/stable runtime/org.kde.Platform/x86_64/5.15-23.08 ``` + Specify the following in your workflow: + ```yaml - name: Build ISO uses: jasonn3/build-container-installer@main @@ -42,14 +50,18 @@ Specify the following in your workflow: flatpak_remote_url: https://flathub.org/repo/flathub.flatpakrepo flatpak_remote_refs_dir: /github/workspace/flatpak_refs ``` + Podman: 1. Create a directory named flatpak_refs 1. Create a file within flatpak_refs with the following content + ``` app/org.videolan.VLC/x86_64/stable runtime/org.kde.Platform/x86_64/5.15-23.08 ``` + Run the following command: + ```bash podman run --privileged --volume ./:/github/workspace/ ghcr.io/jasonn3/build-container-installer:main \ FLATPAK_REMOTE_NAME=flathub \