Copy Wiki from main repo

.github/workflows/update_wiki.yml

@@ -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 "[email protected]"
+          git config --local user.name "GitHub Action"
+          git add .
+          git commit -m "Add changes"
+          git push

README.md

@@ -3,7 +3,7 @@
 
 # Build Container Installer Action
 
-This action is used to generate an ISO for installing an OSTree stored in a container image. This utilizes the anaconda command `ostreecontainer`
+This action is used to generate an ISO for installing an OSTree stored in a container image. This utilizes the anaconda command `ostreecontainer`, which also supports bootc.
 
 ## Usage
 
@@ -36,130 +36,8 @@ This action is designed to be called from a GitHub workflow using the following
     compression-level: 0
 ```
 
-See [Customizing](#customizing) for information about customizing the ISO that gets created using `with`
+**See the [Wiki](https://github.com/JasonN3/build-container-installer/wiki) for development and usage information.**
 
-## Customizing
-
-The following variables can be used to customize the created ISO.
-
-### Inputs
-
-| Variable                | Description                                                                  | Default Value                                | Action             | Container/Makefile |
-| ----------------------- | ---------------------------------------------------------------------------- | -------------------------------------------- | ------------------ | ------------------ |
-| additional_templates    | Space delimited list of additional Lorax templates to include                | \[empty\]                                    | :white_check_mark: | :white_check_mark: |
-| arch                    | Architecture for image to build                                              | x86_64                                       | :white_check_mark: | :white_check_mark: |
-| enrollment_password     | Used for supporting secure boot (requires SECURE_BOOT_KEY_URL to be defined) | container-installer                          | :white_check_mark: | :white_check_mark: |
-| extra_boot_params       | Extra params used by grub to boot the anaconda installer                     | \[empty\]                                    | :white_check_mark: | :white_check_mark: |
-| flatpak_remote_name     | Name of the Flatpak repo on the destination OS                               | flathub                                      | :white_check_mark: | :white_check_mark: |
-| flatpak_remote_refs     | Space separated list of flatpak refs to install                              | \[empty\]                                    | :white_check_mark: | :white_check_mark: |
-| flatpak_remote_refs_dir | Directory that contains files that list the flatpak refs to install          | \[empty\]                                    | :white_check_mark: | :white_check_mark: |
-| flatpak_remote_url      | URL of the flatpakrepo file                                                  | <https://flathub.org/repo/flathub.flatpakrepo> | :white_check_mark: | :white_check_mark: |
-| image_name              | Name of the source container image                                           | base                                         | :white_check_mark: | :white_check_mark: |
-| image_repo              | Repository containing the source container image                             | quay.io/fedora-ostree-desktops               | :white_check_mark: | :white_check_mark: |
-| image_signed            | Whether the container image is signed. The policy to test the signing must be configured inside the container image | true  | :white_check_mark: | :white_check_mark: |
-| image_src               | Overrides the source of the container image. Must be formatted for the skopeo copy command | \[empty\]  | :white_check_mark: | :white_check_mark: |
-| image_tag               | Tag of the source container image                                            | *VERSION*                                    | :white_check_mark: | :white_check_mark: |
-| iso_name                | Name of the ISO you wish to output when completed                            | build/deploy.iso                             | :white_check_mark: | :white_check_mark: |
-| make_target             | Overrides the default make target                                            | *ISO_NAME*-Checksum                          | :white_check_mark: | :x:                |
-| repos                   | List of repo files for Lorax to use                                          | /etc/yum.repos.d/*.repo                      | :white_check_mark: | :white_check_mark: |
-| rootfs_size             | The size (in GiB) for the squashfs runtime volume                            | 2                                            | :white_check_mark: | :white_check_mark: |
-| secure_boot_key_url     | Secure boot key that is installed from URL location\*\*                      | \[empty\]                                    | :white_check_mark: | :white_check_mark: |
-| variant                 | Source container variant\*                                                   | Server                                       | :white_check_mark: | :white_check_mark: |
-| version                 | Fedora version of installer to build                                         | 39                                           | :white_check_mark: | :white_check_mark: |
-| web_ui                  | Enable Anaconda WebUI (experimental)                                         | false                                        | :white_check_mark: | :white_check_mark: |
-
-\*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
-
-\*\* If you need to reference a local file, you can use `file://*path*`
-
-### Outputs
-
-| Variable | Description                             | Usage                                            |
-| -------- | ----------------------------------------| ------------------------------------------------ |
-| iso_name | The name of the resulting .iso          | ${{ steps.YOUR_ID_FOR_ACTION.outputs.iso_name }} |
-| iso_path | The name and path of the resulting .iso | ${{ steps.YOUR_ID_FOR_ACTION.outputs.iso_name }} |
-
-For outputs, see example above.
-
-## Development
-
-### Makefile
-
-The Makefile contains all commands that are run 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.
-
-You can use `make install-deps` to install the required packages.
-
-See [Customizing](#customizing) for information about customizing the ISO that gets created. All variables should be specified in CAPITALIZED form.
-
-### 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. The resulting file will be called `deploy.iso`
-
-See [Customizing](#customizing) for information about customizing the ISO that gets created. All variables should be specified in CAPITALIZED form.
-Examples:
-
-Building an ISO to install Fedora 38
-
-```bash
-docker run --rm --privileged --volume .:/build-container-installer/build  ghcr.io/jasonn3/build-container-installer:latest VERSION=38 IMAGE_NAME=base IMAGE_TAG=38 VARIANT=Server
-```
-
-Building an ISO to install Fedora 39
-
-```bash
-docker 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
-```
-
-### 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
-}
-```
 
 ## Star History
 

docs/Makefile

@@ -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

docs/README.md

@@ -0,0 +1 @@
+These are the files for the [wiki](https://github.com/JasonN3/build-container-installer/wiki)

docs/_Sidebar.md

@@ -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)

docs/development/container.md

@@ -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.

docs/development/makefile.md

@@ -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.

docs/development/vscode.md

@@ -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
+}
+```
+

docs/examples/adding-flatpaks.md

@@ -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"
+```

docs/home.md

@@ -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)