-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
- Loading branch information
1 parent
aa74d32
commit 54d9614
Showing
11 changed files
with
301 additions
and
124 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 |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| name: Update Wiki | ||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| paths: | ||
| - 'docs/**' | ||
| - '.github/workflows/update_wiki.yml' | ||
|
|
||
| jobs: | ||
| update-wiki: | ||
| name: Update Wiki | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: write | ||
| steps: | ||
| - name: Install packages | ||
| run: | | ||
| apt install -y make rsync | ||
| # Checkout Main Repo | ||
| - uses: actions/checkout@v2 | ||
|
|
||
| # Checkout Wiki Repo | ||
| - uses: actions/checkout@v2 | ||
| with: | ||
| repository: ${{github.repository}}.wiki | ||
| persist-credentials: true | ||
| path: wiki | ||
| ref: master | ||
|
|
||
| # Generate final files | ||
| - name: Generate Files | ||
| run: | | ||
| cd ${GITHUB_WORKSPACE}/docs | ||
| make | ||
| # Copy Docs | ||
| - name: Copy files | ||
| run: | | ||
| rsync -av --exclude='.git/*' ${GITHUB_WORKSPACE}/docs/ ${GITHUB_WORKSPACE}/wiki/ | ||
| # Push Changes | ||
| - name: Push changes | ||
| run: | | ||
| cd ${GITHUB_WORKSPACE}/wiki/ | ||
| git config --local user.email "action@github.com" | ||
| git config --local user.name "GitHub Action" | ||
| git add . | ||
| git commit -m "Add changes" | ||
| git push |
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 |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| SHELL = /bin/bash | ||
|
|
||
| docs: | ||
| find -name '*.md' -print0 | xargs -0 -I {} bash -c ' \ | ||
| source_file=$${1:2}; \ | ||
| final_file=$${source_file//\//_}; \ | ||
| mv "$${source_file}" "$${final_file}"; \ | ||
| no_ext_source=$${source_file:0:-3}; \ | ||
| no_ext_final=$${final_file:0:-3}; \ | ||
| sed -i "s;(\(../\)*$${source_file});($${no_ext_final});g" $$(find -name '*.md'); \ | ||
| ' _ {} | ||
| find . -type d -empty -delete |
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 |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| These are the files for the [wiki](https://github.com/JasonN3/build-container-installer/wiki) |
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 |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| - [Home](home.md) | ||
| - Development | ||
| - [Using the Makefile](development/makefile.md) | ||
| - [Using the Container](development/container.md) | ||
| - [Using the VSCode Dev Container](development/vscode.md) | ||
|
|
||
| - Examples | ||
| - [Adding Flatpaks](examples/adding-flatpaks.md) |
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 |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| # Using the 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 `podman 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. The resulting file will be called `deploy.iso` | ||
|
|
||
| See [Inputs](../usage.md#inputs) 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 in CAPITALIZED form. | ||
| Examples: | ||
|
|
||
| Building an ISO to install Fedora 39 | ||
| ```bash | ||
| podman run --rm --privileged --volume .:/build-container-installer/build ghcr.io/jasonn3/build-container-installer:latest VERSION=39 IMAGE_NAME=base IMAGE_TAG=39 VARIANT=Server | ||
| ``` | ||
|
|
||
| Building an ISO to install Fedora 40 | ||
| ```bash | ||
| podman run --rm --privileged --volume .:/build-container-installer/build ghcr.io/jasonn3/build-container-installer:latest VERSION=40 IMAGE_NAME=base IMAGE_TAG=40 VARIANT=Server | ||
| ``` | ||
|
|
||
| The same commands are also available using `docker` by replacing `podman` with `docker` in each command. |
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 |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| # Using the Makefile | ||
|
|
||
| The Makefile contains all 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 [Inputs](../usage.md#inputs) for information about the available parameters. All variables should be specified in CAPITALIZED form. |
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 |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| # Using the 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. | ||
|
|
||
| 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. | ||
|
|
||
| ## Use existing container image | ||
|
|
||
| ```diff | ||
| { | ||
| "name": "Existing Image", | ||
| - "build": { | ||
| - "context": "..", | ||
| - "dockerfile": "../Containerfile", | ||
| - "args": { | ||
| - "version": "39" | ||
| - } | ||
| - }, | ||
| + "image": "ghcr.io/jasonn3/build-container-installer:latest", | ||
| "overrideCommand": true, | ||
| "shutdownAction": "stopContainer", | ||
| "privileged": true | ||
| } | ||
| ``` | ||
|
|
||
| ## Build a new container image | ||
|
|
||
| ```diff | ||
| { | ||
| "name": "New Image", | ||
| + "build": { | ||
| + "context": "..", | ||
| + "dockerfile": "../Containerfile", | ||
| + "args": { | ||
| + "version": "39" | ||
| + } | ||
| + }, | ||
| - "image": "ghcr.io/jasonn3/build-container-installer:latest", | ||
| "overrideCommand": true, | ||
| "shutdownAction": "stopContainer", | ||
| "privileged": true | ||
| } | ||
| ``` | ||
|
|
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 |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| # Adding Flatpaks | ||
|
|
||
| - [Directly using refs](#directly-using-refs) | ||
| - [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 | ||
| id: build | ||
| with: | ||
| flatpak_remote_name: flathub | ||
| 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 \ | ||
| 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" | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## 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 | ||
|
|
||
| ```plaintext | ||
| 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 | ||
| id: build | ||
| with: | ||
| flatpak_remote_name: flathub | ||
| 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 | ||
| ```plaintext | ||
| 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 \ | ||
| 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" | ||
| ``` |
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 |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| Welcome to the build-container-installer wiki! | ||
|
|
||
| ## Index | ||
|
|
||
| - Development | ||
| - [Using the Makefile](development/makefile.md) | ||
| - [Using the Container](development/container.md) | ||
| - [Using the VSCode Dev Container](development/vscode.md) | ||
|
|
||
| - Examples | ||
| - [Adding Flatpaks](examples/adding-flatpaks.md) |
Oops, something went wrong.