From 6f3480e2ea68843cfa80ebeced89a1d0804e7d1a Mon Sep 17 00:00:00 2001 From: Jason N <33561705+JasonN3@users.noreply.github.com> Date: Thu, 15 Feb 2024 13:48:16 -0500 Subject: [PATCH 01/44] feat: Add support anaconda-webui (#1) --- Makefile | 12 +++++++++--- lorax_templates/configure_upgrades.tmpl.in | 6 +++++- 2 files changed, 14 insertions(+), 4 deletions(-) diff --git a/Makefile b/Makefile index d384476..d6a4ba9 100644 --- a/Makefile +++ b/Makefile @@ -3,7 +3,9 @@ version = 39 base_dir = $(shell pwd) image_repo = ghcr.io/ublue-os image_name = base-main +image_tag = $(version) variant = Silverblue +web_ui = false image_repo_escaped = $(subst /,\/,$(image_repo)) image_repo_double_escaped = $(subst \,\\\,$(image_repo_escaped)) @@ -14,6 +16,10 @@ else lorax_args = --nomacboot endif +ifeq ($(web_ui),true) +lorax_args += -i anaconda-webui +endif + $(image_name)-$(version).iso: boot.iso container/$(image_name)-$(version) xorriso/input.txt xorriso -dialog on < $(base_dir)/xorriso/input.txt @@ -31,9 +37,9 @@ boot.iso: lorax_templates/set_installer.tmpl lorax_templates/configure_upgrades. container/$(image_name)-$(version): mkdir container - podman pull $(image_repo)/$(image_name):$(version) - podman save --format oci-dir -o $(base_dir)/container/$(image_name)-$(version) $(image_repo)/$(image_name):$(version) - podman rmi $(image_repo)/$(image_name):$(version) + podman pull $(image_repo)/$(image_name):$(image_tag) + podman save --format oci-dir -o $(base_dir)/container/$(image_name)-$(version) $(image_repo)/$(image_name):$(image_tag) + podman rmi $(image_repo)/$(image_name):$(image_tag) install-deps: dnf install -y lorax xorriso podman git rpm-ostree diff --git a/lorax_templates/configure_upgrades.tmpl.in b/lorax_templates/configure_upgrades.tmpl.in index 2bbb92a..498bf25 100644 --- a/lorax_templates/configure_upgrades.tmpl.in +++ b/lorax_templates/configure_upgrades.tmpl.in @@ -1,3 +1,7 @@ append usr/share/anaconda/interactive-defaults.ks "%post --erroronfail" append usr/share/anaconda/interactive-defaults.ks "sed -i 's/container-image-reference=.*/container-image-reference=ostree-image-signed:docker:\/\/@IMAGE_REPO_ESCAPED@\/@IMAGE_NAME@:@VERSION@/' /ostree/deploy/default/deploy/*.origin" -append usr/share/anaconda/interactive-defaults.ks "%end" \ No newline at end of file +append usr/share/anaconda/interactive-defaults.ks "%end" + +append usr/share/anaconda/post-scripts/configure_upgrades.ks "%post --erroronfail" +append usr/share/anaconda/post-scripts/configure_upgrades.ks "sed -i 's/container-image-reference=.*/container-image-reference=ostree-image-signed:docker:\/\/@IMAGE_REPO_ESCAPED@\/@IMAGE_NAME@:@VERSION@/' /ostree/deploy/default/deploy/*.origin" +append usr/share/anaconda/post-scripts/configure_upgrades.ks "%end" \ No newline at end of file From f32ce26fa72ae672dd8ff17c84a443586ee9b81e Mon Sep 17 00:00:00 2001 From: Benjamin Sherman Date: Thu, 15 Feb 2024 14:11:54 -0600 Subject: [PATCH 02/44] fix: use image_tag not version Hopefully --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index d6a4ba9..112a758 100644 --- a/Makefile +++ b/Makefile @@ -50,7 +50,7 @@ lorax_templates/%.tmpl: lorax_templates/%.tmpl.in sed 's/@IMAGE_NAME@/$(image_name)/' $(base_dir)/lorax_templates/$*.tmpl.in > $(base_dir)/lorax_templates/$*.tmpl sed 's/@IMAGE_REPO@/$(image_repo_escaped)/' $(base_dir)/lorax_templates/$*.tmpl > $(base_dir)/lorax_templates/$*.tmpl.tmp mv $(base_dir)/lorax_templates/$*.tmpl{.tmp,} - sed 's/@VERSION@/$(version)/' $(base_dir)/lorax_templates/$*.tmpl > $(base_dir)/lorax_templates/$*.tmpl.tmp + sed 's/@VERSION@/$(image_tag)/' $(base_dir)/lorax_templates/$*.tmpl > $(base_dir)/lorax_templates/$*.tmpl.tmp mv $(base_dir)/lorax_templates/$*.tmpl{.tmp,} sed 's/@IMAGE_REPO_ESCAPED@/$(image_repo_double_escaped)/' $(base_dir)/lorax_templates/$*.tmpl > $(base_dir)/lorax_templates/$*.tmpl.tmp mv $(base_dir)/lorax_templates/$*.tmpl{.tmp,} From d78c52a68f44bf49ec105aa8e466edc5bb6bbb62 Mon Sep 17 00:00:00 2001 From: HikariKnight <2557889+HikariKnight@users.noreply.github.com> Date: Thu, 15 Feb 2024 21:45:20 +0100 Subject: [PATCH 03/44] Revert "Merge pull request #3 from ublue-os/bsherman-patch-1" This reverts commit aba2f56ebd2439e80336d14e17c24508d97d080a, reversing changes made to 6f3480e2ea68843cfa80ebeced89a1d0804e7d1a. --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 112a758..d6a4ba9 100644 --- a/Makefile +++ b/Makefile @@ -50,7 +50,7 @@ lorax_templates/%.tmpl: lorax_templates/%.tmpl.in sed 's/@IMAGE_NAME@/$(image_name)/' $(base_dir)/lorax_templates/$*.tmpl.in > $(base_dir)/lorax_templates/$*.tmpl sed 's/@IMAGE_REPO@/$(image_repo_escaped)/' $(base_dir)/lorax_templates/$*.tmpl > $(base_dir)/lorax_templates/$*.tmpl.tmp mv $(base_dir)/lorax_templates/$*.tmpl{.tmp,} - sed 's/@VERSION@/$(image_tag)/' $(base_dir)/lorax_templates/$*.tmpl > $(base_dir)/lorax_templates/$*.tmpl.tmp + sed 's/@VERSION@/$(version)/' $(base_dir)/lorax_templates/$*.tmpl > $(base_dir)/lorax_templates/$*.tmpl.tmp mv $(base_dir)/lorax_templates/$*.tmpl{.tmp,} sed 's/@IMAGE_REPO_ESCAPED@/$(image_repo_double_escaped)/' $(base_dir)/lorax_templates/$*.tmpl > $(base_dir)/lorax_templates/$*.tmpl.tmp mv $(base_dir)/lorax_templates/$*.tmpl{.tmp,} From 0a258a446a89bcbd5969ba75aae6ec81a122e496 Mon Sep 17 00:00:00 2001 From: Noel Miller Date: Thu, 15 Feb 2024 17:15:47 -0600 Subject: [PATCH 04/44] feat: Adding Dockerfile to simplify development --- Dockerfile | 18 ++++++++++++++++++ output/README.md | 1 + xorriso/gen_input.sh.in | 4 ++-- 3 files changed, 21 insertions(+), 2 deletions(-) create mode 100644 Dockerfile create mode 100644 output/README.md diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..7cc0492 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,18 @@ +FROM fedora:latest + +ENV ARCH="x86_64" +ENV VERSION="39" +ENV IMAGE_REPO="ghcr.io/ublue-os" +ENV IMAGE_NAME="base-main" +ENV IMAGE_TAG="$(version)" +ENV VARIANT="Silverblue" +ENV WEB_UI="false" + +WORKDIR /isogenerator + +RUN dnf install -y make git && \ + git clone https://github.com/ublue-os/isogenerator.git . && \ + make install-deps + + +ENTRYPOINT ["make", "arch=${ARCH}", "version=${VERSION}", "image_repo=${IMAGE_REPO}", "image_name=${IMAGE_NAME}", "image_tag=${IMAGE_TAG}", "variant=${VARIANT}", "web_ui=${WEB_UI}"] diff --git a/output/README.md b/output/README.md new file mode 100644 index 0000000..fc50ae3 --- /dev/null +++ b/output/README.md @@ -0,0 +1 @@ +Final ISO gets output in this directory diff --git a/xorriso/gen_input.sh.in b/xorriso/gen_input.sh.in index 167e3b0..44b5b47 100644 --- a/xorriso/gen_input.sh.in +++ b/xorriso/gen_input.sh.in @@ -1,7 +1,7 @@ #!/bin/bash echo "-indev $(pwd)/boot.iso" -echo "-outdev $(pwd)/@IMAGE_NAME@-@VERSION@.iso" +echo "-outdev $(pwd)/output/@IMAGE_NAME@-@VERSION@.iso" echo "-boot_image any replay" echo "-volid @IMAGE_NAME@-@ARCH@-@VERSION@" echo "-joliet on" @@ -12,4 +12,4 @@ do echo "-map $(pwd)/${file} ${file}" echo "-chmod 0444 ${file}" done -echo "-end" \ No newline at end of file +echo "-end" From 2226162399883cf5e6bae2ebf5d10e0f76486324 Mon Sep 17 00:00:00 2001 From: Noel Miller <4983138+noelmiller@users.noreply.github.com> Date: Fri, 16 Feb 2024 01:13:04 -0600 Subject: [PATCH 05/44] fix: added workflow_dispatch and fixed workflow --- .github/workflows/iso.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/iso.yml b/.github/workflows/iso.yml index a0b0c6c..388bed6 100644 --- a/.github/workflows/iso.yml +++ b/.github/workflows/iso.yml @@ -7,6 +7,7 @@ on: tags: - 'v*' pull_request: + workflow_dispatch: workflow_call: inputs: @@ -99,7 +100,7 @@ jobs: image_name=${IMAGE_NAME} \ variant=${VARIANT} mkdir end_iso - mv ${IMAGE_NAME}-${IMAGE_VERSION}.iso end_iso/ + mv output/${IMAGE_NAME}-${IMAGE_VERSION}.iso end_iso/ - name: Upload ISO as artifact uses: actions/upload-artifact@v4 From 70bc2264ba3cb30f3e5391611650b5c98f81ff65 Mon Sep 17 00:00:00 2001 From: Noel Miller <4983138+noelmiller@users.noreply.github.com> Date: Fri, 16 Feb 2024 14:45:19 -0600 Subject: [PATCH 06/44] fix: tags not properly being set in ostree remote (#6) * fix: tags are now properly set in remote after install * refactor: kinoite variant is better as a default except for silverblue * refactor: use docker to build ISO --------- Co-authored-by: Benjamin Sherman --- .github/workflows/iso.yml | 92 ++++++++-------------- .github/workflows/isogenerator-image.yml | 84 ++++++++++++++++++++ Dockerfile | 6 +- Makefile | 13 +-- lorax_templates/configure_upgrades.tmpl.in | 4 +- lorax_templates/set_installer.tmpl.in | 2 +- xorriso/gen_input.sh.in | 4 +- 7 files changed, 132 insertions(+), 73 deletions(-) create mode 100644 .github/workflows/isogenerator-image.yml diff --git a/.github/workflows/iso.yml b/.github/workflows/iso.yml index 388bed6..a3de020 100644 --- a/.github/workflows/iso.yml +++ b/.github/workflows/iso.yml @@ -11,10 +11,7 @@ on: workflow_call: inputs: - IMAGE_VERSION: - required: true - type: string - IMAGE_ARCH: + ARCH: required: true type: string IMAGE_NAME: @@ -23,90 +20,67 @@ on: IMAGE_REPO: required: true type: string + IMAGE_TAG: + required: true + type: string VARIANT: required: true type: string + VERSION: + required: true + type: string + WEB_UI: + required: true + type: string BUILD_REPO: required: false type: string - default: JasonN3/container-installer + default: ublue-os/isogenerator BUILD_REF: required: false type: string default: main env: - IMAGE_VERSION: ${{ inputs.IMAGE_VERSION || '39' }} - IMAGE_ARCH: ${{ inputs.IMAGE_ARCH || 'x86_64' }} + ARCH: ${{ inputs.ARCH || 'x86_64' }} IMAGE_NAME: ${{ inputs.IMAGE_NAME || 'base-main' }} IMAGE_REPO: ${{ inputs.IMAGE_REPO || 'ghcr.io/ublue-os' }} - VARIANT: ${{ inputs.VARIANT || 'Silverblue' }} + IMAGE_TAG: ${{ inputs.IMAGE_TAG || 'latest' }} + VARIANT: ${{ inputs.VARIANT || 'Kinoite' }} + VERSION: ${{ inputs.VERSION || '39' }} + WEB_UI: ${{ inputs.WEB_UI || 'false' }} CURR_REPO: ${{ inputs.BUILD_REPO || github.repository }} CURR_REF: ${{ inputs.BUILD_REF || github.ref }} jobs: build-and-push-iso: runs-on: ubuntu-latest - container: - image: fedora:39 - options: "--privileged" permissions: contents: read packages: write steps: - - name: Install make and git - run: dnf install -y make git - - - name: Checkout repository - uses: actions/checkout@v4 - with: - repository: ${{ env.CURR_REPO }} - ref: ${{ env.CURR_REF }} - submodules: recursive - - - name: Install dependencies - run: make install-deps - - - name: Lowercase Registry - id: registry_case - uses: ASzc/change-string-case-action@v6 - with: - string: ${{ env.IMAGE_REPO }} - - - name: Download image + - name: Build ISO + shell: bash run: | - make container/${IMAGE_NAME}-${IMAGE_VERSION} \ - arch=${IMAGE_ARCH} \ - version=${IMAGE_VERSION} \ - image_repo=${{ steps.registry_case.outputs.lowercase }} \ - image_name=${IMAGE_NAME} \ - variant=${VARIANT} - - - name: Create boot.iso - run: | - make boot.iso \ - arch=${IMAGE_ARCH} \ - version=${IMAGE_VERSION} \ - image_repo=${{ steps.registry_case.outputs.lowercase }} \ - image_name=${IMAGE_NAME} \ - variant=${VARIANT} - - - name: Create deploy.iso - run: | - make ${IMAGE_NAME}-${IMAGE_VERSION}.iso \ - arch=${IMAGE_ARCH} \ - version=${IMAGE_VERSION} \ - image_repo=${{ steps.registry_case.outputs.lowercase }} \ - image_name=${IMAGE_NAME} \ - variant=${VARIANT} - mkdir end_iso - mv output/${IMAGE_NAME}-${IMAGE_VERSION}.iso end_iso/ + set -eo pipefail + mkdir -p output + docker run \ + --rm --privileged \ + -v ./output:/isogenerator/output \ + -e ARCH="${{ env.ARCH }}" \ + -e IMAGE_NAME="${{ env.IMAGE_NAME }}" \ + -e IMAGE_REPO="${{ env.IMAGE_REPO }}" \ + -e IMAGE_TAG="${{ env.IMAGE_TAG }}" \ + -e VARIANT="${{ env.VARIANT }}" \ + -e VERSION="${{ env.VERSION }}" \ + -e WEB_UI="${{ env.WEB_UI }}" \ + ghcr.io/ublue-os/isogenerator:latest - name: Upload ISO as artifact uses: actions/upload-artifact@v4 with: - name: ${{ env.IMAGE_NAME }}-${{ env.IMAGE_VERSION }}.iso - path: end_iso/*.iso + name: ${{ env.IMAGE_NAME }}-${{ env.IMAGE_TAG }}.iso + path: output/*.iso if-no-files-found: error retention-days: 0 compression-level: 0 diff --git a/.github/workflows/isogenerator-image.yml b/.github/workflows/isogenerator-image.yml new file mode 100644 index 0000000..c6be3ba --- /dev/null +++ b/.github/workflows/isogenerator-image.yml @@ -0,0 +1,84 @@ +--- +name: isogenerator-image +on: + pull_request: + branches: + - main + paths: + - 'Dockerfile' + push: + branches: + - main + paths: + - 'Dockerfile' + workflow_dispatch: + +env: + IMAGE_NAME: isogenerator + IMAGE_REGISTRY: "ghcr.io/${{ github.repository_owner }}" + +jobs: + push-image: + name: Build and push image + runs-on: ubuntu-22.04 + + permissions: + contents: read + packages: write + id-token: write + + strategy: + fail-fast: false + + steps: + # Checkout push-to-registry action GitHub repository + - name: Checkout Push to Registry action + uses: actions/checkout@v3 + + # Build metadata + - name: Image Metadata + uses: docker/metadata-action@v4 + id: meta + with: + images: | + ${{ env.IMAGE_REGISTRY }}/${{ env.IMAGE_NAME }} + + labels: | + io.artifacthub.package.readme-url=https://raw.githubusercontent.com/${{ github.repository }}/main/README.md + org.opencontainers.image.description=A container image for generating Universal Blue ISO files + org.opencontainers.image.title=${{ env.IMAGE_NAME }} + tags: | + type=ref,event=branch + type=ref,event=pr + # set latest tag for default branch + type=raw,value=latest,enable={{is_default_branch}} + + - name: Login to GitHub Container Registry + uses: docker/login-action@v2 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + - name: Build and Push Image + uses: docker/build-push-action@v4 + with: + context: ./ + file: ./Dockerfile + push: ${{ github.event_name != 'pull_request' }} + labels: ${{ steps.meta.outputs.labels }} + tags: ${{ steps.meta.outputs.tags }} + + check: + name: Check build successful + if: ${{ !cancelled() }} + runs-on: ubuntu-latest + needs: [push-image] + steps: + - name: Exit on failure + if: ${{ needs.push-image.result == 'failure' || needs.push-image.result == 'skipped' }} + shell: bash + run: exit 1 + - name: Exit + shell: bash + run: exit 0 diff --git a/Dockerfile b/Dockerfile index 7cc0492..652cbd1 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,11 +1,11 @@ FROM fedora:latest ENV ARCH="x86_64" -ENV VERSION="39" -ENV IMAGE_REPO="ghcr.io/ublue-os" ENV IMAGE_NAME="base-main" +ENV IMAGE_REPO="ghcr.io/ublue-os" ENV IMAGE_TAG="$(version)" -ENV VARIANT="Silverblue" +ENV VARIANT="Kinoite" +ENV VERSION="39" ENV WEB_UI="false" WORKDIR /isogenerator diff --git a/Makefile b/Makefile index d6a4ba9..317f774 100644 --- a/Makefile +++ b/Makefile @@ -20,7 +20,7 @@ ifeq ($(web_ui),true) lorax_args += -i anaconda-webui endif -$(image_name)-$(version).iso: boot.iso container/$(image_name)-$(version) xorriso/input.txt +$(image_name)-$(version).iso: boot.iso container/$(image_name)-$(image_tag) xorriso/input.txt xorriso -dialog on < $(base_dir)/xorriso/input.txt boot.iso: lorax_templates/set_installer.tmpl lorax_templates/configure_upgrades.tmpl @@ -35,10 +35,10 @@ boot.iso: lorax_templates/set_installer.tmpl lorax_templates/configure_upgrades. $(base_dir)/results/ mv $(base_dir)/results/images/boot.iso $(base_dir)/ -container/$(image_name)-$(version): +container/$(image_name)-$(image_tag): mkdir container podman pull $(image_repo)/$(image_name):$(image_tag) - podman save --format oci-dir -o $(base_dir)/container/$(image_name)-$(version) $(image_repo)/$(image_name):$(image_tag) + podman save --format oci-dir -o $(base_dir)/container/$(image_name)-$(image_tag) $(image_repo)/$(image_name):$(image_tag) podman rmi $(image_repo)/$(image_name):$(image_tag) install-deps: @@ -50,7 +50,7 @@ lorax_templates/%.tmpl: lorax_templates/%.tmpl.in sed 's/@IMAGE_NAME@/$(image_name)/' $(base_dir)/lorax_templates/$*.tmpl.in > $(base_dir)/lorax_templates/$*.tmpl sed 's/@IMAGE_REPO@/$(image_repo_escaped)/' $(base_dir)/lorax_templates/$*.tmpl > $(base_dir)/lorax_templates/$*.tmpl.tmp mv $(base_dir)/lorax_templates/$*.tmpl{.tmp,} - sed 's/@VERSION@/$(version)/' $(base_dir)/lorax_templates/$*.tmpl > $(base_dir)/lorax_templates/$*.tmpl.tmp + sed 's/@IMAGE_TAG@/$(image_tag)/' $(base_dir)/lorax_templates/$*.tmpl > $(base_dir)/lorax_templates/$*.tmpl.tmp mv $(base_dir)/lorax_templates/$*.tmpl{.tmp,} sed 's/@IMAGE_REPO_ESCAPED@/$(image_repo_double_escaped)/' $(base_dir)/lorax_templates/$*.tmpl > $(base_dir)/lorax_templates/$*.tmpl.tmp mv $(base_dir)/lorax_templates/$*.tmpl{.tmp,} @@ -61,7 +61,8 @@ xorriso/input.txt: xorriso/gen_input.sh bash $(base_dir)/xorriso/gen_input.sh | tee $(base_dir)/xorriso/input.txt xorriso/%.sh: xorriso/%.sh.in - sed 's/@IMAGE_NAME@/$(image_name)/' $(base_dir)/xorriso/$*.sh.in > $(base_dir)/xorriso/$*.sh + sed 's/@IMAGE_NAME@/$(image_name)/' $(base_dir)/xorriso/$*.sh.in > $(base_dir)/xorriso/$*.sh.in2 + sed 's/@IMAGE_TAG@/$(image_tag)/' $(base_dir)/xorriso/$*.sh.in2 > $(base_dir)/xorriso/$*.sh sed 's/@VERSION@/$(version)/' $(base_dir)/xorriso/$*.sh > $(base_dir)/xorriso/$*.sh.tmp mv $(base_dir)/xorriso/$*.sh{.tmp,} sed 's/@ARCH@/$(arch)/' $(base_dir)/xorriso/$*.sh > $(base_dir)/xorriso/$*.sh.tmp @@ -79,6 +80,6 @@ clean: rm -f $(base_dir)/{original,final}-pkgsizes.txt || true rm -f $(base_dir)/lorax.conf || true rm -f $(base_dir)/*.iso || true - rm -f $(base_dir)/*.log || true + rm -f $(base_dir)/*.log || true diff --git a/lorax_templates/configure_upgrades.tmpl.in b/lorax_templates/configure_upgrades.tmpl.in index 498bf25..688cf79 100644 --- a/lorax_templates/configure_upgrades.tmpl.in +++ b/lorax_templates/configure_upgrades.tmpl.in @@ -1,7 +1,7 @@ append usr/share/anaconda/interactive-defaults.ks "%post --erroronfail" -append usr/share/anaconda/interactive-defaults.ks "sed -i 's/container-image-reference=.*/container-image-reference=ostree-image-signed:docker:\/\/@IMAGE_REPO_ESCAPED@\/@IMAGE_NAME@:@VERSION@/' /ostree/deploy/default/deploy/*.origin" +append usr/share/anaconda/interactive-defaults.ks "sed -i 's/container-image-reference=.*/container-image-reference=ostree-image-signed:docker:\/\/@IMAGE_REPO_ESCAPED@\/@IMAGE_NAME@:@IMAGE_TAG@/' /ostree/deploy/default/deploy/*.origin" append usr/share/anaconda/interactive-defaults.ks "%end" append usr/share/anaconda/post-scripts/configure_upgrades.ks "%post --erroronfail" -append usr/share/anaconda/post-scripts/configure_upgrades.ks "sed -i 's/container-image-reference=.*/container-image-reference=ostree-image-signed:docker:\/\/@IMAGE_REPO_ESCAPED@\/@IMAGE_NAME@:@VERSION@/' /ostree/deploy/default/deploy/*.origin" +append usr/share/anaconda/post-scripts/configure_upgrades.ks "sed -i 's/container-image-reference=.*/container-image-reference=ostree-image-signed:docker:\/\/@IMAGE_REPO_ESCAPED@\/@IMAGE_NAME@:@IMAGE_TAG@/' /ostree/deploy/default/deploy/*.origin" append usr/share/anaconda/post-scripts/configure_upgrades.ks "%end" \ No newline at end of file diff --git a/lorax_templates/set_installer.tmpl.in b/lorax_templates/set_installer.tmpl.in index 13332ff..522d99a 100644 --- a/lorax_templates/set_installer.tmpl.in +++ b/lorax_templates/set_installer.tmpl.in @@ -1 +1 @@ -append usr/share/anaconda/interactive-defaults.ks "ostreecontainer --url=/run/install/repo/@IMAGE_NAME@-@VERSION@ --transport=oci --no-signature-verification" \ No newline at end of file +append usr/share/anaconda/interactive-defaults.ks "ostreecontainer --url=/run/install/repo/@IMAGE_NAME@-@IMAGE_TAG@ --transport=oci --no-signature-verification" \ No newline at end of file diff --git a/xorriso/gen_input.sh.in b/xorriso/gen_input.sh.in index 44b5b47..299cfc3 100644 --- a/xorriso/gen_input.sh.in +++ b/xorriso/gen_input.sh.in @@ -7,9 +7,9 @@ echo "-volid @IMAGE_NAME@-@ARCH@-@VERSION@" echo "-joliet on" echo "-compliance joliet_long_names" cd container -for file in $(find @IMAGE_NAME@-@VERSION@) +for file in $(find @IMAGE_NAME@-@IMAGE_TAG@) do echo "-map $(pwd)/${file} ${file}" echo "-chmod 0444 ${file}" done -echo "-end" +echo "-end" \ No newline at end of file From c48c28120b9be9db71f8d15f0b4753461b8e80cb Mon Sep 17 00:00:00 2001 From: "Jason N." <33561705+JasonN3@users.noreply.github.com> Date: Fri, 16 Feb 2024 23:40:48 +0000 Subject: [PATCH 07/44] general fixes --- .devcontainer/devcontainer.json | 16 +++ ...enerator-image.yml => build-container.yml} | 8 +- .github/workflows/iso.yml | 87 ------------- .github/workflows/test-iso.yml | 43 ++++++ .gitignore | 2 +- CODEOWNERS | 2 + Containerfile | 21 +++ Dockerfile | 18 --- Makefile | 122 ++++++++++-------- README.md | 94 +++++++++++++- action.yml | 112 ++++++++++++++++ output/README.md | 1 - xorriso/gen_input.sh.in | 4 +- 13 files changed, 357 insertions(+), 173 deletions(-) create mode 100644 .devcontainer/devcontainer.json rename .github/workflows/{isogenerator-image.yml => build-container.yml} (96%) delete mode 100644 .github/workflows/iso.yml create mode 100644 .github/workflows/test-iso.yml create mode 100644 CODEOWNERS create mode 100644 Containerfile delete mode 100644 Dockerfile create mode 100644 action.yml delete mode 100644 output/README.md diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json new file mode 100644 index 0000000..babf01e --- /dev/null +++ b/.devcontainer/devcontainer.json @@ -0,0 +1,16 @@ +// For format details, see https://aka.ms/devcontainer.json. For config options, see the +// README at: https://github.com/devcontainers/templates/tree/main/src/docker-existing-dockerfile +{ + "name": "Existing Dockerfile", + // "build": { + // "context": "..", + // "dockerfile": "../Containerfile", + // "args": { + // "version": "39" + // } + // }, + "image": "ghcr.io/ublue-os/isogenerator:latest", + "overrideCommand": true, + "shutdownAction": "stopContainer", + "privileged": true +} diff --git a/.github/workflows/isogenerator-image.yml b/.github/workflows/build-container.yml similarity index 96% rename from .github/workflows/isogenerator-image.yml rename to .github/workflows/build-container.yml index c6be3ba..3ce9188 100644 --- a/.github/workflows/isogenerator-image.yml +++ b/.github/workflows/build-container.yml @@ -1,5 +1,5 @@ --- -name: isogenerator-image +name: Create Container on: pull_request: branches: @@ -21,15 +21,9 @@ jobs: push-image: name: Build and push image runs-on: ubuntu-22.04 - permissions: contents: read packages: write - id-token: write - - strategy: - fail-fast: false - steps: # Checkout push-to-registry action GitHub repository - name: Checkout Push to Registry action diff --git a/.github/workflows/iso.yml b/.github/workflows/iso.yml deleted file mode 100644 index a3de020..0000000 --- a/.github/workflows/iso.yml +++ /dev/null @@ -1,87 +0,0 @@ -name: Create and publish an ISO - -on: - push: - branches: - - 'main' - tags: - - 'v*' - pull_request: - workflow_dispatch: - - workflow_call: - inputs: - ARCH: - required: true - type: string - IMAGE_NAME: - required: true - type: string - IMAGE_REPO: - required: true - type: string - IMAGE_TAG: - required: true - type: string - VARIANT: - required: true - type: string - VERSION: - required: true - type: string - WEB_UI: - required: true - type: string - BUILD_REPO: - required: false - type: string - default: ublue-os/isogenerator - BUILD_REF: - required: false - type: string - default: main - -env: - ARCH: ${{ inputs.ARCH || 'x86_64' }} - IMAGE_NAME: ${{ inputs.IMAGE_NAME || 'base-main' }} - IMAGE_REPO: ${{ inputs.IMAGE_REPO || 'ghcr.io/ublue-os' }} - IMAGE_TAG: ${{ inputs.IMAGE_TAG || 'latest' }} - VARIANT: ${{ inputs.VARIANT || 'Kinoite' }} - VERSION: ${{ inputs.VERSION || '39' }} - WEB_UI: ${{ inputs.WEB_UI || 'false' }} - CURR_REPO: ${{ inputs.BUILD_REPO || github.repository }} - CURR_REF: ${{ inputs.BUILD_REF || github.ref }} - -jobs: - build-and-push-iso: - runs-on: ubuntu-latest - permissions: - contents: read - packages: write - steps: - - name: Build ISO - shell: bash - run: | - set -eo pipefail - mkdir -p output - docker run \ - --rm --privileged \ - -v ./output:/isogenerator/output \ - -e ARCH="${{ env.ARCH }}" \ - -e IMAGE_NAME="${{ env.IMAGE_NAME }}" \ - -e IMAGE_REPO="${{ env.IMAGE_REPO }}" \ - -e IMAGE_TAG="${{ env.IMAGE_TAG }}" \ - -e VARIANT="${{ env.VARIANT }}" \ - -e VERSION="${{ env.VERSION }}" \ - -e WEB_UI="${{ env.WEB_UI }}" \ - ghcr.io/ublue-os/isogenerator:latest - - - name: Upload ISO as artifact - uses: actions/upload-artifact@v4 - with: - name: ${{ env.IMAGE_NAME }}-${{ env.IMAGE_TAG }}.iso - path: output/*.iso - if-no-files-found: error - retention-days: 0 - compression-level: 0 - overwrite: true diff --git a/.github/workflows/test-iso.yml b/.github/workflows/test-iso.yml new file mode 100644 index 0000000..4eb4425 --- /dev/null +++ b/.github/workflows/test-iso.yml @@ -0,0 +1,43 @@ +name: Test Generate ISO + +on: + push: + branches: + - 'main' + tags: + - 'v*' + pull_request: + +env: + ARCH: ${{ inputs.ARCH || 'x86_64' }} + IMAGE_NAME: ${{ inputs.IMAGE_NAME || 'base-main' }} + IMAGE_REPO: ${{ inputs.IMAGE_REPO || 'ghcr.io/ublue-os' }} + IMAGE_TAG: ${{ inputs.IMAGE_TAG || 'latest' }} + VARIANT: ${{ inputs.VARIANT || 'Kinoite' }} + VERSION: ${{ inputs.VERSION || '39' }} + WEB_UI: ${{ inputs.WEB_UI || 'false' }} + CURR_REPO: ${{ inputs.BUILD_REPO || github.repository }} + CURR_REF: ${{ inputs.BUILD_REF || github.ref }} + +jobs: + build-and-push-iso: + runs-on: ubuntu-latest + container: + image: fedora:39 + options: "--privileged" + permissions: + contents: read + packages: write + steps: + - name: Build ISO + uses: ublue-os/isogenerator + with: + ARCH: 'x86_64' + IMAGE_NAME: 'base-main' + IMAGE_REPO: 'ghcr.io/ublue-os' + IMAGE_TAG: 'latest' + VARIANT: 'Kinoite' + VERSION: '39' + WEB_UI: 'false' + CURR_REPO: ${{ github.repository }} + CURR_REF: ${{ github.ref }} diff --git a/.gitignore b/.gitignore index 03894b9..23d7903 100644 --- a/.gitignore +++ b/.gitignore @@ -8,5 +8,5 @@ /original-pkgsizes.txt /final-pkgsizes.txt /lorax.conf -/*.iso +/output /*.log \ No newline at end of file diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 0000000..d446188 --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1,2 @@ +# Default owner of code within this repo +* @JasonN3 \ No newline at end of file diff --git a/Containerfile b/Containerfile new file mode 100644 index 0000000..b783659 --- /dev/null +++ b/Containerfile @@ -0,0 +1,21 @@ +ARG version=39 + +FROM fedora:${version} + +ENV ARCH="x86_64" +ENV IMAGE_NAME="base-main" +ENV IMAGE_REPO="ghcr.io/ublue-os" +ENV IMAGE_TAG="${version}" +ENV VARIANT="Kinoite" +ENV VERSION="${version}" +ENV WEB_UI="false" + +COPY / /isogenerator +WORKDIR /isogenerator + +RUN dnf install -y make && make install-deps + +VOLUME /isogenerator/output + +ENTRYPOINT ["make" ] +CMD [ "ARCH=${ARCH}", "VERSION=${VERSION}", "IMAGE_REPO=${IMAGE_REPO}", "IMAGE_NAME=${IMAGE_NAME}", "IMAGE_TAG=${IMAGE_TAG}", "VARIANT=${VARIANT}", "WEB_UI=${WEB_UI}"] diff --git a/Dockerfile b/Dockerfile deleted file mode 100644 index 652cbd1..0000000 --- a/Dockerfile +++ /dev/null @@ -1,18 +0,0 @@ -FROM fedora:latest - -ENV ARCH="x86_64" -ENV IMAGE_NAME="base-main" -ENV IMAGE_REPO="ghcr.io/ublue-os" -ENV IMAGE_TAG="$(version)" -ENV VARIANT="Kinoite" -ENV VERSION="39" -ENV WEB_UI="false" - -WORKDIR /isogenerator - -RUN dnf install -y make git && \ - git clone https://github.com/ublue-os/isogenerator.git . && \ - make install-deps - - -ENTRYPOINT ["make", "arch=${ARCH}", "version=${VERSION}", "image_repo=${IMAGE_REPO}", "image_name=${IMAGE_NAME}", "image_tag=${IMAGE_TAG}", "variant=${VARIANT}", "web_ui=${WEB_UI}"] diff --git a/Makefile b/Makefile index 317f774..27a4666 100644 --- a/Makefile +++ b/Makefile @@ -1,85 +1,97 @@ -arch = x86_64 -version = 39 -base_dir = $(shell pwd) -image_repo = ghcr.io/ublue-os -image_name = base-main -image_tag = $(version) -variant = Silverblue -web_ui = false +# Configuration vars +## Formatting = UPPERCASE +ARCH = x86_64 +VERSION = 39 +IMAGE_REPO = ghcr.io/ublue-os +IMAGE_NAME = base-main +IMAGE_TAG = $(version) +VARIANT = Silverblue +WEB_UI = false -image_repo_escaped = $(subst /,\/,$(image_repo)) -image_repo_double_escaped = $(subst \,\\\,$(image_repo_escaped)) +# Generated vars +## Formatting = _UPPERCASE +_BASE_DIR = $(shell pwd) +_IMAGE_REPO_ESCAPED = $(subst /,\/,$(IMAGE_REPO)) +_IMAGE_REPO_DOUBLE_ESCAPED = $(subst \,\\\,$(_IMAGE_REPO_ESCAPED)) -ifeq ($(variant),'Server') -lorax_args = --macboot --noupgrade +ifeq ($(VARIANT),'Server') +_LORAX_ARGS = --macboot --noupgrade else -lorax_args = --nomacboot +_LORAX_ARGS = --nomacboot endif -ifeq ($(web_ui),true) -lorax_args += -i anaconda-webui +ifeq ($(WEB_UI),true) +_LORAX_ARGS += -i anaconda-webui endif -$(image_name)-$(version).iso: boot.iso container/$(image_name)-$(image_tag) xorriso/input.txt - xorriso -dialog on < $(base_dir)/xorriso/input.txt +# Step 6: Build end ISO file +## Default action +$(IMAGE_NAME)-$(IMAGE_TAG).iso: boot.iso container/$(IMAGE_NAME)-$(IMAGE_TAG) xorriso/input.txt + mkdir $(_BASE_DIR)/output + xorriso -dialog on < $(_BASE_DIR)/xorriso/input.txt +# Step 2: Build boot.iso using Lorax boot.iso: lorax_templates/set_installer.tmpl lorax_templates/configure_upgrades.tmpl - rm -Rf $(base_dir)/results - lorax -p $(image_name) -v $(version) -r $(version) -t $(variant) \ - --isfinal --buildarch=$(arch) --volid=$(image_name)-$(arch)-$(version) \ - $(lorax_args) \ + rm -Rf $(_BASE_DIR)/results + lorax -p $(IMAGE_NAME) -v $(VERSION) -r $(VERSION) -t $(VARIANT) \ + --isfinal --buildarch=$(ARCH) --volid=$(IMAGE_NAME)-$(ARCH)-$(VERSION) \ + $(_LORAX_ARGS) \ --repo /etc/yum.repos.d/fedora.repo \ --repo /etc/yum.repos.d/fedora-updates.repo \ - --add-template $(base_dir)/lorax_templates/set_installer.tmpl \ - --add-template $(base_dir)/lorax_templates/configure_upgrades.tmpl \ - $(base_dir)/results/ - mv $(base_dir)/results/images/boot.iso $(base_dir)/ + --add-template $(_BASE_DIR)/lorax_templates/set_installer.tmpl \ + --add-template $(_BASE_DIR)/lorax_templates/configure_upgrades.tmpl \ + $(_BASE_DIR)/results/ + mv $(_BASE_DIR)/results/images/boot.iso $(_BASE_DIR)/ -container/$(image_name)-$(image_tag): +# Step 3: Download container image +container/$(IMAGE_NAME)-$(IMAGE_TAG): mkdir container - podman pull $(image_repo)/$(image_name):$(image_tag) - podman save --format oci-dir -o $(base_dir)/container/$(image_name)-$(image_tag) $(image_repo)/$(image_name):$(image_tag) - podman rmi $(image_repo)/$(image_name):$(image_tag) + podman pull $(IMAGE_REPO)/$(IMAGE_NAME):$(IMAGE_TAG) + podman save --format oci-dir -o $(_BASE_DIR)/container/$(IMAGE_NAME)-$(IMAGE_TAG) $(IMAGE_REPO)/$(IMAGE_NAME):$(IMAGE_TAG) + podman rmi $(IMAGE_REPO)/$(IMAGE_NAME):$(IMAGE_TAG) install-deps: dnf install -y lorax xorriso podman git rpm-ostree - +# Step 1: Generate Lorax Templates lorax_templates/%.tmpl: lorax_templates/%.tmpl.in - sed 's/@IMAGE_NAME@/$(image_name)/' $(base_dir)/lorax_templates/$*.tmpl.in > $(base_dir)/lorax_templates/$*.tmpl - sed 's/@IMAGE_REPO@/$(image_repo_escaped)/' $(base_dir)/lorax_templates/$*.tmpl > $(base_dir)/lorax_templates/$*.tmpl.tmp - mv $(base_dir)/lorax_templates/$*.tmpl{.tmp,} - sed 's/@IMAGE_TAG@/$(image_tag)/' $(base_dir)/lorax_templates/$*.tmpl > $(base_dir)/lorax_templates/$*.tmpl.tmp - mv $(base_dir)/lorax_templates/$*.tmpl{.tmp,} - sed 's/@IMAGE_REPO_ESCAPED@/$(image_repo_double_escaped)/' $(base_dir)/lorax_templates/$*.tmpl > $(base_dir)/lorax_templates/$*.tmpl.tmp - mv $(base_dir)/lorax_templates/$*.tmpl{.tmp,} + sed 's/@IMAGE_NAME@/$(IMAGE_NAME)/' $(_BASE_DIR)/lorax_templates/$*.tmpl.in > $(_BASE_DIR)/lorax_templates/$*.tmpl + + sed 's/@IMAGE_TAG@/$(IMAGE_TAG)/' $(_BASE_DIR)/lorax_templates/$*.tmpl > $(_BASE_DIR)/lorax_templates/$*.tmpl.tmp + mv $(_BASE_DIR)/lorax_templates/$*.tmpl{.tmp,} + + sed 's/@IMAGE_REPO_ESCAPED@/$(_IMAGE_REPO_DOUBLE_ESCAPED)/' $(_BASE_DIR)/lorax_templates/$*.tmpl > $(_BASE_DIR)/lorax_templates/$*.tmpl.tmp + mv $(_BASE_DIR)/lorax_templates/$*.tmpl{.tmp,} +# Step 5: Generate xorriso input xorriso/input.txt: xorriso/gen_input.sh - bash $(base_dir)/xorriso/gen_input.sh | tee $(base_dir)/xorriso/input.txt + bash $(_BASE_DIR)/xorriso/gen_input.sh | tee $(_BASE_DIR)/xorriso/input.txt +# Step 4: Generate xorriso script xorriso/%.sh: xorriso/%.sh.in - sed 's/@IMAGE_NAME@/$(image_name)/' $(base_dir)/xorriso/$*.sh.in > $(base_dir)/xorriso/$*.sh.in2 - sed 's/@IMAGE_TAG@/$(image_tag)/' $(base_dir)/xorriso/$*.sh.in2 > $(base_dir)/xorriso/$*.sh - sed 's/@VERSION@/$(version)/' $(base_dir)/xorriso/$*.sh > $(base_dir)/xorriso/$*.sh.tmp - mv $(base_dir)/xorriso/$*.sh{.tmp,} - sed 's/@ARCH@/$(arch)/' $(base_dir)/xorriso/$*.sh > $(base_dir)/xorriso/$*.sh.tmp - mv $(base_dir)/xorriso/$*.sh{.tmp,} + sed 's/@IMAGE_NAME@/$(IMAGE_NAME)/' $(_BASE_DIR)/xorriso/$*.sh.in > $(_BASE_DIR)/xorriso/$*.sh + + sed 's/@IMAGE_TAG@/$(IMAGE_TAG)/' $(_BASE_DIR)/xorriso/$*.sh > $(_BASE_DIR)/xorriso/$*.sh.tmp + mv $(_BASE_DIR)/xorriso/$*.sh{.tmp,} + + sed 's/@ARCH@/$(ARCH)/' $(_BASE_DIR)/xorriso/$*.sh > $(_BASE_DIR)/xorriso/$*.sh.tmp + mv $(_BASE_DIR)/xorriso/$*.sh{.tmp,} clean: - rm -Rf $(base_dir)/container || true - rm -Rf $(base_dir)/debugdata || true - rm -Rf $(base_dir)/pkglists || true - rm -Rf $(base_dir)/results || true - rm -f $(base_dir)/lorax_templates/*.tmpl || true - rm -f $(base_dir)/xorriso/input.txt || true - rm -f $(base_dir)/xorriso/*.sh || true - rm -f $(base_dir)/{original,final}-pkgsizes.txt || true - rm -f $(base_dir)/lorax.conf || true - rm -f $(base_dir)/*.iso || true - rm -f $(base_dir)/*.log || true + rm -Rf $(_BASE_DIR)/container || true + rm -Rf $(_BASE_DIR)/debugdata || true + rm -Rf $(_BASE_DIR)/pkglists || true + rm -Rf $(_BASE_DIR)/results || true + rm -f $(_BASE_DIR)/lorax_templates/*.tmpl || true + rm -f $(_BASE_DIR)/xorriso/input.txt || true + rm -f $(_BASE_DIR)/xorriso/*.sh || true + rm -f $(_BASE_DIR)/{original,final}-pkgsizes.txt || true + rm -f $(_BASE_DIR)/lorax.conf || true + rm -f $(_BASE_DIR)/*.iso || true + rm -f $(_BASE_DIR)/*.log || true diff --git a/README.md b/README.md index 8d1402b..b489f0c 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,92 @@ -# container-installer -Creates an ISO for installing a container image as an OS +# UBlueOS ISO Generator +This action is used to generate the ISO images for UBlueOS. + + +## Makefile +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. + +See [Customizing](#customizing) for information about customizing the image that gets created. + +## Container +A container with the necessary tools already installed is provided at `ghcr.io/ublue-os/isogenerator:latest` + +To use the container file, run `docker --privileged --volume .:/isogenerator/output ghcr.io/ublue-os/isogenerator` + +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: +Environment Variable +```bash +docker --privileged --volume .:/isogenerator/output -e VERSION=39 ghcr.io/ublue-os/isogenerator +``` +Command Argument +```bash +docker --privileged --volume .:/isogenerator/output ghcr.io/ublue-os/isogenerator VERSION=39 +``` + +## Customizing +The following variables can be used to customize the create image. + +- ARCH + Architecture for image to build + Default Value: x86_64 +- VERSION + Fedora version of installer to build + Default Value: 39 +- IMAGE_REPO + Repository containing the source container image + Default Value: ghcr.io/ublue-os +- IMAGE_NAME + Name of the source container image + Default Value: base-main +- IMAGE_TAG + Tag of the source container image + Default Value: *VERSION* +- VARIANT + Source container variant + Silverblue +- WEB_UI + Enable Anaconda WebUI + false + +## 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/ublue-os/isogenerator`, 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/isogenerator` once the container has started. + +Privileged is required for access to loop devices for lorax. + +Use existing image +```json +{ + "name": "Existing Dockerfile", + // "build": { + // "context": "..", + // "dockerfile": "../Containerfile", + // "args": { + // "version": "39" + // } + // }, + "image": "ghcr.io/ublue-os/isogenerator:latest", + "overrideCommand": true, + "shutdownAction": "stopContainer", + "privileged": true +} +``` + +Build a new image +```json +{ + "name": "Existing Dockerfile", + "build": { + "context": "..", + "dockerfile": "../Containerfile", + "args": { + "version": "39" + } + }, + //"image": "ghcr.io/ublue-os/isogenerator:latest", + "overrideCommand": true, + "shutdownAction": "stopContainer", + "privileged": true +} +``` \ No newline at end of file diff --git a/action.yml b/action.yml new file mode 100644 index 0000000..bba7ecb --- /dev/null +++ b/action.yml @@ -0,0 +1,112 @@ +name: Generate ISO +description: Creates an ISO for installing an OSTree container + +inputs: + ARCH: + description: Architecture for image to build + required: true + default: x86_64 + IMAGE_NAME: + description: Name of the source container image + required: true + default: base-main + IMAGE_REPO: + description: Repository containing the source container image + required: true + default: ghcr.io/ublue-os + IMAGE_TAG: + description: Tag of the source container image + required: true + default: ${{ inputs.VERSION }} + VARIANT: + description: Source container variant + required: true + default: Kinoite + VERSION: + description: Fedora version of installer to build + required: true + default: "39" + WEB_UI: + description: Enable Anaconda WebUI + required: true + default: "false" + BUILD_REPO: + description: Repository with the build tool + required: false + default: ${{ github.repository }} + BUILD_REF: + description: Repository ref for the build tool + required: false + default: ${{ github.ref }} + +runs: + using: composite + steps: + - name: Install make and git + shell: bash + run: dnf install -y make git + + - name: Checkout repository + uses: actions/checkout@v4 + with: + repository: ${{ inputs.BUILD_REPO }} + ref: ${{ inputs.BUILD_REF }} + submodules: recursive + + - name: Install dependencies + shell: bash + run: make install-deps + + - name: Lowercase Registry + id: registry_case + uses: ASzc/change-string-case-action@v6 + with: + string: ${{ inputs.IMAGE_REPO }} + + - name: Download image + shell: bash + run: | + make container/${{ inputs.IMAGE_NAME }}-${{ inputs.IMAGE_TAG }} \ + ARCH=${{ inputs.ARCH }} \ + IMAGE_NAME=${{ inputs.IMAGE_NAME }} \ + IMAGE_REPO=${{ steps.registry_case.outputs.lowercase }} \ + IMAGE_TAG=${{ inputs.IMAGE_TAG }} \ + VARIANT=${{ inputs.VARIANT }} \ + VERSION=${{ inputs.VERSION }} \ + WEB_UI=${{ inputs.WEB_UI }} + + - name: Create boot.iso + shell: bash + run: | + make boot.iso \ + ARCH=${{ inputs.ARCH }} \ + IMAGE_NAME=${{ inputs.IMAGE_NAME }} \ + IMAGE_REPO=${{ steps.registry_case.outputs.lowercase }} \ + IMAGE_TAG=${{ inputs.IMAGE_TAG }} \ + VARIANT=${{ inputs.VARIANT }} \ + VERSION=${{ inputs.VERSION }} \ + WEB_UI=${{ inputs.WEB_UI }} + + - name: Create deploy.iso + shell: bash + run: | + make ${IMAGE_NAME}-${IMAGE_VERSION}.iso \ + ARCH=${{ inputs.ARCH }} \ + IMAGE_NAME=${{ inputs.IMAGE_NAME }} \ + IMAGE_REPO=${{ steps.registry_case.outputs.lowercase }} \ + IMAGE_TAG=${{ inputs.IMAGE_TAG }} \ + VARIANT=${{ inputs.VARIANT }} \ + VERSION=${{ inputs.VERSION }} \ + WEB_UI=${{ inputs.WEB_UI }} + mkdir end_iso + mv output/${IMAGE_NAME}-${IMAGE_TAG}.iso end_iso/ + + - name: Upload ISO as artifact + uses: actions/upload-artifact@v4 + with: + name: ${{ inputs.IMAGE_NAME }}-${{ inputs.IMAGE_VERSION }}.iso + path: end_iso/*.iso + if-no-files-found: error + retention-days: 0 + compression-level: 0 + overwrite: true diff --git a/output/README.md b/output/README.md deleted file mode 100644 index fc50ae3..0000000 --- a/output/README.md +++ /dev/null @@ -1 +0,0 @@ -Final ISO gets output in this directory diff --git a/xorriso/gen_input.sh.in b/xorriso/gen_input.sh.in index 299cfc3..30d73fa 100644 --- a/xorriso/gen_input.sh.in +++ b/xorriso/gen_input.sh.in @@ -1,9 +1,9 @@ #!/bin/bash echo "-indev $(pwd)/boot.iso" -echo "-outdev $(pwd)/output/@IMAGE_NAME@-@VERSION@.iso" +echo "-outdev $(pwd)/output/@IMAGE_NAME@-@IMAGE_TAG@.iso" echo "-boot_image any replay" -echo "-volid @IMAGE_NAME@-@ARCH@-@VERSION@" +echo "-volid @IMAGE_NAME@-@ARCH@-@IMAGE_TAG@" echo "-joliet on" echo "-compliance joliet_long_names" cd container From 96b1379d6c54153d4c229f460787f59b3fdf7cf6 Mon Sep 17 00:00:00 2001 From: "Jason N." <33561705+JasonN3@users.noreply.github.com> Date: Sun, 18 Feb 2024 19:12:30 +0000 Subject: [PATCH 08/44] update workflow --- .github/workflows/build-container.yml | 73 +++++++-------------------- .github/workflows/test-iso.yml | 29 ++++++----- Containerfile | 8 +-- action.yml | 12 ++--- 4 files changed, 43 insertions(+), 79 deletions(-) diff --git a/.github/workflows/build-container.yml b/.github/workflows/build-container.yml index 3ce9188..c502a6b 100644 --- a/.github/workflows/build-container.yml +++ b/.github/workflows/build-container.yml @@ -4,14 +4,9 @@ on: pull_request: branches: - main - paths: - - 'Dockerfile' push: branches: - main - paths: - - 'Dockerfile' - workflow_dispatch: env: IMAGE_NAME: isogenerator @@ -24,55 +19,23 @@ jobs: permissions: contents: read packages: write + strategy: + fail-fast: false + matrix: + version: + - 38 + - 39 + - 40 + include: + - version: 39 + support: latest steps: - # Checkout push-to-registry action GitHub repository - - name: Checkout Push to Registry action - uses: actions/checkout@v3 - - # Build metadata - - name: Image Metadata - uses: docker/metadata-action@v4 - id: meta + - name: Build image + uses: JasonN3/build-action@action with: - images: | - ${{ env.IMAGE_REGISTRY }}/${{ env.IMAGE_NAME }} - - labels: | - io.artifacthub.package.readme-url=https://raw.githubusercontent.com/${{ github.repository }}/main/README.md - org.opencontainers.image.description=A container image for generating Universal Blue ISO files - org.opencontainers.image.title=${{ env.IMAGE_NAME }} - tags: | - type=ref,event=branch - type=ref,event=pr - # set latest tag for default branch - type=raw,value=latest,enable={{is_default_branch}} - - - name: Login to GitHub Container Registry - uses: docker/login-action@v2 - with: - registry: ghcr.io - username: ${{ github.actor }} - password: ${{ secrets.GITHUB_TOKEN }} - - - name: Build and Push Image - uses: docker/build-push-action@v4 - with: - context: ./ - file: ./Dockerfile - push: ${{ github.event_name != 'pull_request' }} - labels: ${{ steps.meta.outputs.labels }} - tags: ${{ steps.meta.outputs.tags }} - - check: - name: Check build successful - if: ${{ !cancelled() }} - runs-on: ubuntu-latest - needs: [push-image] - steps: - - name: Exit on failure - if: ${{ needs.push-image.result == 'failure' || needs.push-image.result == 'skipped' }} - shell: bash - run: exit 1 - - name: Exit - shell: bash - run: exit 0 + image_name: isogenerator + image_variant: main + version: ${{ matrix.version }} + support: ${{ matrix.support }} + signing_key: ${{ secrets.SIGNING_SECRET }} + continue-on-error: false diff --git a/.github/workflows/test-iso.yml b/.github/workflows/test-iso.yml index 4eb4425..9deabf5 100644 --- a/.github/workflows/test-iso.yml +++ b/.github/workflows/test-iso.yml @@ -3,21 +3,22 @@ name: Test Generate ISO on: push: branches: - - 'main' + - main tags: - 'v*' + paths-ignore: + - 'Containerfile' + - '*.md' + - 'LICENSE' + - 'CODEOWNERS' pull_request: - -env: - ARCH: ${{ inputs.ARCH || 'x86_64' }} - IMAGE_NAME: ${{ inputs.IMAGE_NAME || 'base-main' }} - IMAGE_REPO: ${{ inputs.IMAGE_REPO || 'ghcr.io/ublue-os' }} - IMAGE_TAG: ${{ inputs.IMAGE_TAG || 'latest' }} - VARIANT: ${{ inputs.VARIANT || 'Kinoite' }} - VERSION: ${{ inputs.VERSION || '39' }} - WEB_UI: ${{ inputs.WEB_UI || 'false' }} - CURR_REPO: ${{ inputs.BUILD_REPO || github.repository }} - CURR_REF: ${{ inputs.BUILD_REF || github.ref }} + branches: + - main + paths-ignore: + - 'Containerfile' + - '*.md' + - 'LICENSE' + - 'CODEOWNERS' jobs: build-and-push-iso: @@ -39,5 +40,5 @@ jobs: VARIANT: 'Kinoite' VERSION: '39' WEB_UI: 'false' - CURR_REPO: ${{ github.repository }} - CURR_REF: ${{ github.ref }} + ACTION_REPO: ${{ github.repository }} + ACTION_REF: ${{ github.ref }} diff --git a/Containerfile b/Containerfile index b783659..32a4162 100644 --- a/Containerfile +++ b/Containerfile @@ -1,13 +1,13 @@ -ARG version=39 +ARG VERSION=39 -FROM fedora:${version} +FROM fedora:${VERSION} ENV ARCH="x86_64" ENV IMAGE_NAME="base-main" ENV IMAGE_REPO="ghcr.io/ublue-os" -ENV IMAGE_TAG="${version}" +ENV IMAGE_TAG="${VERSION}" ENV VARIANT="Kinoite" -ENV VERSION="${version}" +ENV VERSION="${VERSION}" ENV WEB_UI="false" COPY / /isogenerator diff --git a/action.yml b/action.yml index bba7ecb..fd5da35 100644 --- a/action.yml +++ b/action.yml @@ -30,12 +30,12 @@ inputs: description: Enable Anaconda WebUI required: true default: "false" - BUILD_REPO: - description: Repository with the build tool + ACTION_REPO: + description: Repository with the build action required: false default: ${{ github.repository }} - BUILD_REF: - description: Repository ref for the build tool + ACTION_REF: + description: Repository ref for the build action required: false default: ${{ github.ref }} @@ -49,8 +49,8 @@ runs: - name: Checkout repository uses: actions/checkout@v4 with: - repository: ${{ inputs.BUILD_REPO }} - ref: ${{ inputs.BUILD_REF }} + repository: ${{ inputs.ACTION_REPO }} + ref: ${{ inputs.ACTION_REF }} submodules: recursive - name: Install dependencies From 6ab23f79d237ae056d3fc7c9738c3d3692de8653 Mon Sep 17 00:00:00 2001 From: "Jason N." <33561705+JasonN3@users.noreply.github.com> Date: Sun, 18 Feb 2024 19:30:20 +0000 Subject: [PATCH 09/44] reference file directly --- .github/workflows/test-iso.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/test-iso.yml b/.github/workflows/test-iso.yml index 9deabf5..5ef81bd 100644 --- a/.github/workflows/test-iso.yml +++ b/.github/workflows/test-iso.yml @@ -31,7 +31,7 @@ jobs: packages: write steps: - name: Build ISO - uses: ublue-os/isogenerator + uses: ./action.yml with: ARCH: 'x86_64' IMAGE_NAME: 'base-main' From 73b0799030ab3208db1a56713c1da938c82f7090 Mon Sep 17 00:00:00 2001 From: "Jason N." <33561705+JasonN3@users.noreply.github.com> Date: Sun, 18 Feb 2024 19:38:08 +0000 Subject: [PATCH 10/44] checkout before run --- .github/workflows/build-container.yml | 11 +++++------ .github/workflows/test-iso.yml | 15 +++++++++++++-- 2 files changed, 18 insertions(+), 8 deletions(-) diff --git a/.github/workflows/build-container.yml b/.github/workflows/build-container.yml index c502a6b..bbce12d 100644 --- a/.github/workflows/build-container.yml +++ b/.github/workflows/build-container.yml @@ -1,5 +1,5 @@ --- -name: Create Container +name: Build Container on: pull_request: branches: @@ -8,13 +8,9 @@ on: branches: - main -env: - IMAGE_NAME: isogenerator - IMAGE_REGISTRY: "ghcr.io/${{ github.repository_owner }}" - jobs: push-image: - name: Build and push image + name: Build and push container image runs-on: ubuntu-22.04 permissions: contents: read @@ -30,6 +26,9 @@ jobs: - version: 39 support: latest steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Build image uses: JasonN3/build-action@action with: diff --git a/.github/workflows/test-iso.yml b/.github/workflows/test-iso.yml index 5ef81bd..d3d9468 100644 --- a/.github/workflows/test-iso.yml +++ b/.github/workflows/test-iso.yml @@ -22,6 +22,7 @@ on: jobs: build-and-push-iso: + name: Build ISO runs-on: ubuntu-latest container: image: fedora:39 @@ -29,6 +30,16 @@ jobs: permissions: contents: read packages: write + strategy: + fail-fast: false + matrix: + version: + - 38 + - 39 + - 40 + include: + - version: 40 + web_ui: 'true' steps: - name: Build ISO uses: ./action.yml @@ -38,7 +49,7 @@ jobs: IMAGE_REPO: 'ghcr.io/ublue-os' IMAGE_TAG: 'latest' VARIANT: 'Kinoite' - VERSION: '39' - WEB_UI: 'false' + VERSION: ${{ matrix.version }} + WEB_UI: ${{ matrix.web_ui }} ACTION_REPO: ${{ github.repository }} ACTION_REF: ${{ github.ref }} From 91141ce742471bc1e4587557f83655b779bf3e71 Mon Sep 17 00:00:00 2001 From: "Jason N." <33561705+JasonN3@users.noreply.github.com> Date: Sun, 18 Feb 2024 19:39:31 +0000 Subject: [PATCH 11/44] fix: add checkout to right workflow --- .github/workflows/build-container.yml | 3 --- .github/workflows/test-iso.yml | 3 +++ 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/build-container.yml b/.github/workflows/build-container.yml index bbce12d..85e3a62 100644 --- a/.github/workflows/build-container.yml +++ b/.github/workflows/build-container.yml @@ -26,9 +26,6 @@ jobs: - version: 39 support: latest steps: - - name: Checkout - uses: actions/checkout@v4 - - name: Build image uses: JasonN3/build-action@action with: diff --git a/.github/workflows/test-iso.yml b/.github/workflows/test-iso.yml index d3d9468..c16ad45 100644 --- a/.github/workflows/test-iso.yml +++ b/.github/workflows/test-iso.yml @@ -41,6 +41,9 @@ jobs: - version: 40 web_ui: 'true' steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Build ISO uses: ./action.yml with: From 2c16c58fbc0a6e3ac25c4c6d91a96039698b5684 Mon Sep 17 00:00:00 2001 From: "Jason N." <33561705+JasonN3@users.noreply.github.com> Date: Sun, 18 Feb 2024 19:43:20 +0000 Subject: [PATCH 12/44] test action in root --- .github/workflows/test-iso.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/test-iso.yml b/.github/workflows/test-iso.yml index c16ad45..e68822e 100644 --- a/.github/workflows/test-iso.yml +++ b/.github/workflows/test-iso.yml @@ -43,9 +43,9 @@ jobs: steps: - name: Checkout uses: actions/checkout@v4 - + - name: Build ISO - uses: ./action.yml + uses: ./ with: ARCH: 'x86_64' IMAGE_NAME: 'base-main' From 50bf71eab5978c83e9e6ce4bdfa426199f3a3820 Mon Sep 17 00:00:00 2001 From: "Jason N." <33561705+JasonN3@users.noreply.github.com> Date: Sun, 18 Feb 2024 19:53:12 +0000 Subject: [PATCH 13/44] fixes --- Containerfile | 2 +- Makefile | 3 +++ action.yml | 21 ++++++++++----------- 3 files changed, 14 insertions(+), 12 deletions(-) diff --git a/Containerfile b/Containerfile index 32a4162..e5f3d74 100644 --- a/Containerfile +++ b/Containerfile @@ -17,5 +17,5 @@ RUN dnf install -y make && make install-deps VOLUME /isogenerator/output -ENTRYPOINT ["make" ] +ENTRYPOINT ["make", "output/${IMAGE_NAME}-${IMAGE_TAG}.iso"] CMD [ "ARCH=${ARCH}", "VERSION=${VERSION}", "IMAGE_REPO=${IMAGE_REPO}", "IMAGE_NAME=${IMAGE_NAME}", "IMAGE_TAG=${IMAGE_TAG}", "VARIANT=${VARIANT}", "WEB_UI=${WEB_UI}"] diff --git a/Makefile b/Makefile index 27a4666..28cadcb 100644 --- a/Makefile +++ b/Makefile @@ -30,6 +30,9 @@ $(IMAGE_NAME)-$(IMAGE_TAG).iso: boot.iso container/$(IMAGE_NAME)-$(IMAGE_TAG) xo mkdir $(_BASE_DIR)/output xorriso -dialog on < $(_BASE_DIR)/xorriso/input.txt +output/$(IMAGE_NAME)-$(IMAGE_TAG).iso: $(IMAGE_NAME)-$(IMAGE_TAG).iso + cp $(IMAGE_NAME)-$(IMAGE_TAG).iso output/$(IMAGE_NAME)-$(IMAGE_TAG).iso + # Step 2: Build boot.iso using Lorax boot.iso: lorax_templates/set_installer.tmpl lorax_templates/configure_upgrades.tmpl rm -Rf $(_BASE_DIR)/results diff --git a/action.yml b/action.yml index fd5da35..0944290 100644 --- a/action.yml +++ b/action.yml @@ -14,10 +14,6 @@ inputs: description: Repository containing the source container image required: true default: ghcr.io/ublue-os - IMAGE_TAG: - description: Tag of the source container image - required: true - default: ${{ inputs.VERSION }} VARIANT: description: Source container variant required: true @@ -26,6 +22,9 @@ inputs: description: Fedora version of installer to build required: true default: "39" + IMAGE_TAG: + description: Tag of the source container image + required: false WEB_UI: description: Enable Anaconda WebUI required: true @@ -66,11 +65,11 @@ runs: - name: Download image shell: bash run: | - make container/${{ inputs.IMAGE_NAME }}-${{ inputs.IMAGE_TAG }} \ + make container/${{ inputs.IMAGE_NAME }}-${{ inputs.IMAGE_TAG || inputs.VERSION }} \ ARCH=${{ inputs.ARCH }} \ IMAGE_NAME=${{ inputs.IMAGE_NAME }} \ IMAGE_REPO=${{ steps.registry_case.outputs.lowercase }} \ - IMAGE_TAG=${{ inputs.IMAGE_TAG }} \ + IMAGE_TAG=${{ inputs.IMAGE_TAG || inputs.VERSION }} \ VARIANT=${{ inputs.VARIANT }} \ VERSION=${{ inputs.VERSION }} \ WEB_UI=${{ inputs.WEB_UI }} @@ -82,7 +81,7 @@ runs: ARCH=${{ inputs.ARCH }} \ IMAGE_NAME=${{ inputs.IMAGE_NAME }} \ IMAGE_REPO=${{ steps.registry_case.outputs.lowercase }} \ - IMAGE_TAG=${{ inputs.IMAGE_TAG }} \ + IMAGE_TAG=${{ inputs.IMAGE_TAG || inputs.VERSION }} \ VARIANT=${{ inputs.VARIANT }} \ VERSION=${{ inputs.VERSION }} \ WEB_UI=${{ inputs.WEB_UI }} @@ -90,21 +89,21 @@ runs: - name: Create deploy.iso shell: bash run: | - make ${IMAGE_NAME}-${IMAGE_VERSION}.iso \ + make ${{ inputs.IMAGE_NAME }}-${{ inputs.IMAGE_TAG || inputs.VERSION }}.iso \ ARCH=${{ inputs.ARCH }} \ IMAGE_NAME=${{ inputs.IMAGE_NAME }} \ IMAGE_REPO=${{ steps.registry_case.outputs.lowercase }} \ - IMAGE_TAG=${{ inputs.IMAGE_TAG }} \ + IMAGE_TAG=${{ inputs.IMAGE_TAG || inputs.VERSION }} \ VARIANT=${{ inputs.VARIANT }} \ VERSION=${{ inputs.VERSION }} \ WEB_UI=${{ inputs.WEB_UI }} mkdir end_iso - mv output/${IMAGE_NAME}-${IMAGE_TAG}.iso end_iso/ + mv ${{ IMAGE_NAME }}-${{ inputs.IMAGE_TAG || inputs.VERSION }}.iso end_iso/ - name: Upload ISO as artifact uses: actions/upload-artifact@v4 with: - name: ${{ inputs.IMAGE_NAME }}-${{ inputs.IMAGE_VERSION }}.iso + name: ${{ inputs.IMAGE_NAME }}-${{ inputs.IMAGE_TAG || inputs.VERSION }}.iso path: end_iso/*.iso if-no-files-found: error retention-days: 0 From 2290aa62097d035573a13d338c24379dacd9ffb9 Mon Sep 17 00:00:00 2001 From: "Jason N." <33561705+JasonN3@users.noreply.github.com> Date: Sun, 18 Feb 2024 20:03:42 +0000 Subject: [PATCH 14/44] missing inputs --- action.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/action.yml b/action.yml index 0944290..064cee2 100644 --- a/action.yml +++ b/action.yml @@ -98,7 +98,7 @@ runs: VERSION=${{ inputs.VERSION }} \ WEB_UI=${{ inputs.WEB_UI }} mkdir end_iso - mv ${{ IMAGE_NAME }}-${{ inputs.IMAGE_TAG || inputs.VERSION }}.iso end_iso/ + mv ${{ inputs.IMAGE_NAME }}-${{ inputs.IMAGE_TAG || inputs.VERSION }}.iso end_iso/ - name: Upload ISO as artifact uses: actions/upload-artifact@v4 From 31b6b39b23caab7da79d10213a8c8706e37db7d4 Mon Sep 17 00:00:00 2001 From: "Jason N." <33561705+JasonN3@users.noreply.github.com> Date: Mon, 19 Feb 2024 14:20:08 +0000 Subject: [PATCH 15/44] allow multiple output locations --- .github/workflows/test-iso.yml | 5 ----- Makefile | 8 ++++---- 2 files changed, 4 insertions(+), 9 deletions(-) diff --git a/.github/workflows/test-iso.yml b/.github/workflows/test-iso.yml index e68822e..50f75ea 100644 --- a/.github/workflows/test-iso.yml +++ b/.github/workflows/test-iso.yml @@ -36,10 +36,6 @@ jobs: version: - 38 - 39 - - 40 - include: - - version: 40 - web_ui: 'true' steps: - name: Checkout uses: actions/checkout@v4 @@ -53,6 +49,5 @@ jobs: IMAGE_TAG: 'latest' VARIANT: 'Kinoite' VERSION: ${{ matrix.version }} - WEB_UI: ${{ matrix.web_ui }} ACTION_REPO: ${{ github.repository }} ACTION_REF: ${{ github.ref }} diff --git a/Makefile b/Makefile index 28cadcb..d8499ff 100644 --- a/Makefile +++ b/Makefile @@ -26,13 +26,13 @@ endif # Step 6: Build end ISO file ## Default action -$(IMAGE_NAME)-$(IMAGE_TAG).iso: boot.iso container/$(IMAGE_NAME)-$(IMAGE_TAG) xorriso/input.txt +$(IMAGE_NAME)-$(IMAGE_TAG).iso: output/$(IMAGE_NAME)-$(IMAGE_TAG).iso + mv output/$(IMAGE_NAME)-$(IMAGE_TAG).iso $(IMAGE_NAME)-$(IMAGE_TAG).iso + +output/$(IMAGE_NAME)-$(IMAGE_TAG).iso: boot.iso container/$(IMAGE_NAME)-$(IMAGE_TAG) xorriso/input.txt mkdir $(_BASE_DIR)/output xorriso -dialog on < $(_BASE_DIR)/xorriso/input.txt -output/$(IMAGE_NAME)-$(IMAGE_TAG).iso: $(IMAGE_NAME)-$(IMAGE_TAG).iso - cp $(IMAGE_NAME)-$(IMAGE_TAG).iso output/$(IMAGE_NAME)-$(IMAGE_TAG).iso - # Step 2: Build boot.iso using Lorax boot.iso: lorax_templates/set_installer.tmpl lorax_templates/configure_upgrades.tmpl rm -Rf $(_BASE_DIR)/results From c720fb3dc51f69f82ea16cfa6551308977349574 Mon Sep 17 00:00:00 2001 From: "Jason N." <33561705+JasonN3@users.noreply.github.com> Date: Mon, 19 Feb 2024 14:39:03 +0000 Subject: [PATCH 16/44] move codeowners --- CODEOWNERS => .github/CODEOWNERS | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename CODEOWNERS => .github/CODEOWNERS (100%) diff --git a/CODEOWNERS b/.github/CODEOWNERS similarity index 100% rename from CODEOWNERS rename to .github/CODEOWNERS From 5ab0abdb2f80b0bfc960abc2cd124a70c100d8b2 Mon Sep 17 00:00:00 2001 From: "Jason N." <33561705+JasonN3@users.noreply.github.com> Date: Mon, 19 Feb 2024 10:15:22 -0500 Subject: [PATCH 17/44] make pr check requirements easier --- .github/workflows/build-container.yml | 15 +++++++++++++++ .github/workflows/test-iso.yml | 15 +++++++++++++++ 2 files changed, 30 insertions(+) diff --git a/.github/workflows/build-container.yml b/.github/workflows/build-container.yml index 85e3a62..bd35ade 100644 --- a/.github/workflows/build-container.yml +++ b/.github/workflows/build-container.yml @@ -35,3 +35,18 @@ jobs: support: ${{ matrix.support }} signing_key: ${{ secrets.SIGNING_SECRET }} continue-on-error: false + + check: + name: Check build successful + if: ${{ !cancelled() }} + runs-on: ubuntu-latest + needs: + - push-image + steps: + - name: Exit on failure for main + if: ${{ needs.push-image.result == 'failure' || needs.push-image.result == 'skipped' }} + shell: bash + run: exit 1 + - name: Exit + shell: bash + run: exit 0 \ No newline at end of file diff --git a/.github/workflows/test-iso.yml b/.github/workflows/test-iso.yml index 50f75ea..9b818f5 100644 --- a/.github/workflows/test-iso.yml +++ b/.github/workflows/test-iso.yml @@ -51,3 +51,18 @@ jobs: VERSION: ${{ matrix.version }} ACTION_REPO: ${{ github.repository }} ACTION_REF: ${{ github.ref }} + + check: + name: Check build successful + if: ${{ !cancelled() }} + runs-on: ubuntu-latest + needs: + - build-and-push-iso + steps: + - name: Exit on failure for main + if: ${{ needs.build-and-push-iso.result == 'failure' || needs.build-and-push-iso.result == 'skipped' }} + shell: bash + run: exit 1 + - name: Exit + shell: bash + run: exit 0 \ No newline at end of file From cda1689641f551ebde52623807dbe6842e493533 Mon Sep 17 00:00:00 2001 From: "Jason N." <33561705+JasonN3@users.noreply.github.com> Date: Mon, 19 Feb 2024 12:18:18 -0500 Subject: [PATCH 18/44] doc: update VARIANT description to include how to find options --- action.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/action.yml b/action.yml index 064cee2..119679c 100644 --- a/action.yml +++ b/action.yml @@ -15,7 +15,7 @@ inputs: required: true default: ghcr.io/ublue-os VARIANT: - description: Source container variant + description: "Source container variant. Available options 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 kinonite" required: true default: Kinoite VERSION: From e7172778d0aa5fd9e7895986ddb76f06dc36e9b9 Mon Sep 17 00:00:00 2001 From: "Jason N." <33561705+JasonN3@users.noreply.github.com> Date: Mon, 19 Feb 2024 12:18:37 -0500 Subject: [PATCH 19/44] doc: re-order to put steps in order --- Makefile | 36 +++++++++++++++++------------------- 1 file changed, 17 insertions(+), 19 deletions(-) diff --git a/Makefile b/Makefile index d8499ff..49945e2 100644 --- a/Makefile +++ b/Makefile @@ -24,15 +24,26 @@ ifeq ($(WEB_UI),true) _LORAX_ARGS += -i anaconda-webui endif -# Step 6: Build end ISO file +# Step 7: Move end ISO to root ## Default action $(IMAGE_NAME)-$(IMAGE_TAG).iso: output/$(IMAGE_NAME)-$(IMAGE_TAG).iso mv output/$(IMAGE_NAME)-$(IMAGE_TAG).iso $(IMAGE_NAME)-$(IMAGE_TAG).iso +# Step 6: Build end ISO file output/$(IMAGE_NAME)-$(IMAGE_TAG).iso: boot.iso container/$(IMAGE_NAME)-$(IMAGE_TAG) xorriso/input.txt mkdir $(_BASE_DIR)/output xorriso -dialog on < $(_BASE_DIR)/xorriso/input.txt +# Step 1: Generate Lorax Templates +lorax_templates/%.tmpl: lorax_templates/%.tmpl.in + sed 's/@IMAGE_NAME@/$(IMAGE_NAME)/' $(_BASE_DIR)/lorax_templates/$*.tmpl.in > $(_BASE_DIR)/lorax_templates/$*.tmpl + + sed 's/@IMAGE_TAG@/$(IMAGE_TAG)/' $(_BASE_DIR)/lorax_templates/$*.tmpl > $(_BASE_DIR)/lorax_templates/$*.tmpl.tmp + mv $(_BASE_DIR)/lorax_templates/$*.tmpl{.tmp,} + + sed 's/@IMAGE_REPO_ESCAPED@/$(_IMAGE_REPO_DOUBLE_ESCAPED)/' $(_BASE_DIR)/lorax_templates/$*.tmpl > $(_BASE_DIR)/lorax_templates/$*.tmpl.tmp + mv $(_BASE_DIR)/lorax_templates/$*.tmpl{.tmp,} + # Step 2: Build boot.iso using Lorax boot.iso: lorax_templates/set_installer.tmpl lorax_templates/configure_upgrades.tmpl rm -Rf $(_BASE_DIR)/results @@ -56,23 +67,6 @@ container/$(IMAGE_NAME)-$(IMAGE_TAG): install-deps: dnf install -y lorax xorriso podman git rpm-ostree - -# Step 1: Generate Lorax Templates -lorax_templates/%.tmpl: lorax_templates/%.tmpl.in - sed 's/@IMAGE_NAME@/$(IMAGE_NAME)/' $(_BASE_DIR)/lorax_templates/$*.tmpl.in > $(_BASE_DIR)/lorax_templates/$*.tmpl - - sed 's/@IMAGE_TAG@/$(IMAGE_TAG)/' $(_BASE_DIR)/lorax_templates/$*.tmpl > $(_BASE_DIR)/lorax_templates/$*.tmpl.tmp - mv $(_BASE_DIR)/lorax_templates/$*.tmpl{.tmp,} - - sed 's/@IMAGE_REPO_ESCAPED@/$(_IMAGE_REPO_DOUBLE_ESCAPED)/' $(_BASE_DIR)/lorax_templates/$*.tmpl > $(_BASE_DIR)/lorax_templates/$*.tmpl.tmp - mv $(_BASE_DIR)/lorax_templates/$*.tmpl{.tmp,} - - - -# Step 5: Generate xorriso input -xorriso/input.txt: xorriso/gen_input.sh - bash $(_BASE_DIR)/xorriso/gen_input.sh | tee $(_BASE_DIR)/xorriso/input.txt - # Step 4: Generate xorriso script xorriso/%.sh: xorriso/%.sh.in sed 's/@IMAGE_NAME@/$(IMAGE_NAME)/' $(_BASE_DIR)/xorriso/$*.sh.in > $(_BASE_DIR)/xorriso/$*.sh @@ -83,6 +77,10 @@ xorriso/%.sh: xorriso/%.sh.in sed 's/@ARCH@/$(ARCH)/' $(_BASE_DIR)/xorriso/$*.sh > $(_BASE_DIR)/xorriso/$*.sh.tmp mv $(_BASE_DIR)/xorriso/$*.sh{.tmp,} +# Step 5: Generate xorriso input +xorriso/input.txt: xorriso/gen_input.sh + bash $(_BASE_DIR)/xorriso/gen_input.sh | tee $(_BASE_DIR)/xorriso/input.txt + clean: rm -Rf $(_BASE_DIR)/container || true @@ -97,4 +95,4 @@ clean: rm -f $(_BASE_DIR)/*.iso || true rm -f $(_BASE_DIR)/*.log || true - +.PHONY: clean From 1a58c1260876f4e7502a4be1744bfb0956d850b2 Mon Sep 17 00:00:00 2001 From: "Jason N." <33561705+JasonN3@users.noreply.github.com> Date: Mon, 19 Feb 2024 12:32:42 -0500 Subject: [PATCH 20/44] fix: don't push the iso during testing --- .github/workflows/test-iso.yml | 1 + action.yml | 5 +++++ 2 files changed, 6 insertions(+) diff --git a/.github/workflows/test-iso.yml b/.github/workflows/test-iso.yml index 9b818f5..d39a260 100644 --- a/.github/workflows/test-iso.yml +++ b/.github/workflows/test-iso.yml @@ -51,6 +51,7 @@ jobs: VERSION: ${{ matrix.version }} ACTION_REPO: ${{ github.repository }} ACTION_REF: ${{ github.ref }} + PUSH_ISO: "false" check: name: Check build successful diff --git a/action.yml b/action.yml index 119679c..afe87da 100644 --- a/action.yml +++ b/action.yml @@ -37,6 +37,10 @@ inputs: description: Repository ref for the build action required: false default: ${{ github.ref }} + PUSH_ISO: + description: Push ISO when done building + required: false + default: "true" runs: using: composite @@ -101,6 +105,7 @@ runs: mv ${{ inputs.IMAGE_NAME }}-${{ inputs.IMAGE_TAG || inputs.VERSION }}.iso end_iso/ - name: Upload ISO as artifact + if: inputs.PUSH_ISO == "true" uses: actions/upload-artifact@v4 with: name: ${{ inputs.IMAGE_NAME }}-${{ inputs.IMAGE_TAG || inputs.VERSION }}.iso From a0cfe4e05a75d81b1d0c10055f1d5479f3aedb07 Mon Sep 17 00:00:00 2001 From: "Jason N." <33561705+JasonN3@users.noreply.github.com> Date: Mon, 19 Feb 2024 12:34:01 -0500 Subject: [PATCH 21/44] single quotes --- action.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/action.yml b/action.yml index afe87da..d3140ce 100644 --- a/action.yml +++ b/action.yml @@ -105,7 +105,7 @@ runs: mv ${{ inputs.IMAGE_NAME }}-${{ inputs.IMAGE_TAG || inputs.VERSION }}.iso end_iso/ - name: Upload ISO as artifact - if: inputs.PUSH_ISO == "true" + if: inputs.PUSH_ISO == 'true' uses: actions/upload-artifact@v4 with: name: ${{ inputs.IMAGE_NAME }}-${{ inputs.IMAGE_TAG || inputs.VERSION }}.iso From 0f9cb8812cb1950dca74be0f7a4737a3318d6051 Mon Sep 17 00:00:00 2001 From: "Jason N." <33561705+JasonN3@users.noreply.github.com> Date: Mon, 19 Feb 2024 12:38:14 -0500 Subject: [PATCH 22/44] fix: always push for testing and include variant in ISO name --- .github/workflows/test-iso.yml | 1 - action.yml | 7 +------ 2 files changed, 1 insertion(+), 7 deletions(-) diff --git a/.github/workflows/test-iso.yml b/.github/workflows/test-iso.yml index d39a260..9b818f5 100644 --- a/.github/workflows/test-iso.yml +++ b/.github/workflows/test-iso.yml @@ -51,7 +51,6 @@ jobs: VERSION: ${{ matrix.version }} ACTION_REPO: ${{ github.repository }} ACTION_REF: ${{ github.ref }} - PUSH_ISO: "false" check: name: Check build successful diff --git a/action.yml b/action.yml index d3140ce..4d73841 100644 --- a/action.yml +++ b/action.yml @@ -37,10 +37,6 @@ inputs: description: Repository ref for the build action required: false default: ${{ github.ref }} - PUSH_ISO: - description: Push ISO when done building - required: false - default: "true" runs: using: composite @@ -105,10 +101,9 @@ runs: mv ${{ inputs.IMAGE_NAME }}-${{ inputs.IMAGE_TAG || inputs.VERSION }}.iso end_iso/ - name: Upload ISO as artifact - if: inputs.PUSH_ISO == 'true' uses: actions/upload-artifact@v4 with: - name: ${{ inputs.IMAGE_NAME }}-${{ inputs.IMAGE_TAG || inputs.VERSION }}.iso + name: ${{ inputs.IMAGE_NAME }}-${{ inputs.IMAGE_TAG || inputs.VERSION }}-${{ inputs.VARIANT }}.iso path: end_iso/*.iso if-no-files-found: error retention-days: 0 From 0a69cfe2e9df26d6935c8e37331971f2c7fbd314 Mon Sep 17 00:00:00 2001 From: "Jason N." <33561705+JasonN3@users.noreply.github.com> Date: Mon, 19 Feb 2024 12:41:39 -0500 Subject: [PATCH 23/44] fix: only run test on PR --- .github/workflows/test-iso.yml | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/.github/workflows/test-iso.yml b/.github/workflows/test-iso.yml index 9b818f5..2e1d99f 100644 --- a/.github/workflows/test-iso.yml +++ b/.github/workflows/test-iso.yml @@ -1,16 +1,6 @@ name: Test Generate ISO on: - push: - branches: - - main - tags: - - 'v*' - paths-ignore: - - 'Containerfile' - - '*.md' - - 'LICENSE' - - 'CODEOWNERS' pull_request: branches: - main From d4eb37fc5f721f524d94dcf8ed363c822b8e1d99 Mon Sep 17 00:00:00 2001 From: Jason N <33561705+JasonN3@users.noreply.github.com> Date: Mon, 19 Feb 2024 18:17:27 -0500 Subject: [PATCH 24/44] doc: copy variant description from action --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b489f0c..e5edc2c 100644 --- a/README.md +++ b/README.md @@ -42,11 +42,12 @@ The following variables can be used to customize the create image. Tag of the source container image Default Value: *VERSION* - VARIANT - Source container variant - Silverblue + Source container variant + Source container variant. Available options 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 kinonite + Default Value: Silverblue - WEB_UI Enable Anaconda WebUI - false + Default Value: false ## 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/ublue-os/isogenerator`, 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. @@ -89,4 +90,4 @@ Build a new image "shutdownAction": "stopContainer", "privileged": true } -``` \ No newline at end of file +``` From 8faf73deaae3f4b2a8eace04fdd1dceaa24784e1 Mon Sep 17 00:00:00 2001 From: "Jason N." <33561705+JasonN3@users.noreply.github.com> Date: Mon, 19 Feb 2024 20:56:42 -0500 Subject: [PATCH 25/44] remove duplicate text and upgrade build version --- .github/workflows/build-container.yml | 3 ++- README.md | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build-container.yml b/.github/workflows/build-container.yml index bd35ade..76b97aa 100644 --- a/.github/workflows/build-container.yml +++ b/.github/workflows/build-container.yml @@ -27,13 +27,14 @@ jobs: support: latest steps: - name: Build image - uses: JasonN3/build-action@action + uses: ublue-os/build-action@1.0.1 with: image_name: isogenerator image_variant: main version: ${{ matrix.version }} support: ${{ matrix.support }} signing_key: ${{ secrets.SIGNING_SECRET }} + target: main continue-on-error: false check: diff --git a/README.md b/README.md index e5edc2c..b3575d0 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ The following variables can be used to customize the create image. Default Value: *VERSION* - VARIANT Source container variant - Source container variant. Available options 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 kinonite + Available options 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 kinonite Default Value: Silverblue - WEB_UI Enable Anaconda WebUI From fe7443ffccd14b77fdf169025f0b1f84369dbf52 Mon Sep 17 00:00:00 2001 From: "Jason N." <33561705+JasonN3@users.noreply.github.com> Date: Mon, 19 Feb 2024 22:21:27 -0500 Subject: [PATCH 26/44] fix: remove target --- .github/workflows/build-container.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/build-container.yml b/.github/workflows/build-container.yml index 76b97aa..b4c3674 100644 --- a/.github/workflows/build-container.yml +++ b/.github/workflows/build-container.yml @@ -34,7 +34,6 @@ jobs: version: ${{ matrix.version }} support: ${{ matrix.support }} signing_key: ${{ secrets.SIGNING_SECRET }} - target: main continue-on-error: false check: From ea1a7c96239f8f189389b54c2beb87cedc1f7634 Mon Sep 17 00:00:00 2001 From: "Jason N." <33561705+JasonN3@users.noreply.github.com> Date: Tue, 20 Feb 2024 10:25:29 -0500 Subject: [PATCH 27/44] free up extra space --- action.yml | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/action.yml b/action.yml index 4d73841..c08f1ee 100644 --- a/action.yml +++ b/action.yml @@ -41,6 +41,25 @@ inputs: runs: using: composite steps: + - name: Cleanup host + shell: bash + run: | + if [[ -d /host ]] + then + df -h /host + # Remove Android Library + rm -Rf /host/usr/local/lib/android + # Remove .NET runtime + rm -Rf /host/usr/share/dotnet + # Remove Haskell runtime + rm -rf /host/opt/ghc + rm -rf /host/usr/local/.ghcup + chroot /host docker image prune --all --force + df -h /host + else + echo "Host must be mounted as /host in order to make more space" + fi + - name: Install make and git shell: bash run: dnf install -y make git From 6e7bef78061860855a3f2893e46641e6b06b178c Mon Sep 17 00:00:00 2001 From: "Jason N." <33561705+JasonN3@users.noreply.github.com> Date: Tue, 20 Feb 2024 10:45:01 -0500 Subject: [PATCH 28/44] don't include tag --- .github/workflows/test-iso.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/workflows/test-iso.yml b/.github/workflows/test-iso.yml index 2e1d99f..916a40d 100644 --- a/.github/workflows/test-iso.yml +++ b/.github/workflows/test-iso.yml @@ -36,9 +36,8 @@ jobs: ARCH: 'x86_64' IMAGE_NAME: 'base-main' IMAGE_REPO: 'ghcr.io/ublue-os' - IMAGE_TAG: 'latest' VARIANT: 'Kinoite' - VERSION: ${{ matrix.version }} + VERSION: 39 ACTION_REPO: ${{ github.repository }} ACTION_REF: ${{ github.ref }} From 441364b76eaf0feddf3f0cf4aab601c73a77cc46 Mon Sep 17 00:00:00 2001 From: "Jason N." <33561705+JasonN3@users.noreply.github.com> Date: Tue, 20 Feb 2024 10:59:35 -0500 Subject: [PATCH 29/44] use var --- .github/workflows/test-iso.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/test-iso.yml b/.github/workflows/test-iso.yml index 916a40d..4039402 100644 --- a/.github/workflows/test-iso.yml +++ b/.github/workflows/test-iso.yml @@ -37,7 +37,7 @@ jobs: IMAGE_NAME: 'base-main' IMAGE_REPO: 'ghcr.io/ublue-os' VARIANT: 'Kinoite' - VERSION: 39 + VERSION: ${{ matrix.version }} ACTION_REPO: ${{ github.repository }} ACTION_REF: ${{ github.ref }} From 21687175339947683509b4ebd0fa2b586d1efd38 Mon Sep 17 00:00:00 2001 From: "Jason N." <33561705+JasonN3@users.noreply.github.com> Date: Tue, 20 Feb 2024 11:55:52 -0500 Subject: [PATCH 30/44] fix: expand name --- .github/workflows/build-container.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build-container.yml b/.github/workflows/build-container.yml index b4c3674..0c17baa 100644 --- a/.github/workflows/build-container.yml +++ b/.github/workflows/build-container.yml @@ -1,5 +1,5 @@ --- -name: Build Container +name: Build Container Image on: pull_request: branches: From b3e24eabda91db663f51398306a42f3faad5e585 Mon Sep 17 00:00:00 2001 From: "Jason N." <33561705+JasonN3@users.noreply.github.com> Date: Tue, 20 Feb 2024 13:13:56 -0500 Subject: [PATCH 31/44] fix: match action defaults --- .../{build-container.yml => build-container-image.yml} | 0 .github/workflows/test-iso.yml | 1 + Makefile | 2 +- 3 files changed, 2 insertions(+), 1 deletion(-) rename .github/workflows/{build-container.yml => build-container-image.yml} (100%) diff --git a/.github/workflows/build-container.yml b/.github/workflows/build-container-image.yml similarity index 100% rename from .github/workflows/build-container.yml rename to .github/workflows/build-container-image.yml diff --git a/.github/workflows/test-iso.yml b/.github/workflows/test-iso.yml index 4039402..0465b1b 100644 --- a/.github/workflows/test-iso.yml +++ b/.github/workflows/test-iso.yml @@ -1,6 +1,7 @@ name: Test Generate ISO on: + merge_group: pull_request: branches: - main diff --git a/Makefile b/Makefile index 49945e2..b189d20 100644 --- a/Makefile +++ b/Makefile @@ -5,7 +5,7 @@ VERSION = 39 IMAGE_REPO = ghcr.io/ublue-os IMAGE_NAME = base-main IMAGE_TAG = $(version) -VARIANT = Silverblue +VARIANT = Kinoite WEB_UI = false # Generated vars From 3999189402689670710dfc79876df31e4067920d Mon Sep 17 00:00:00 2001 From: Noel Miller <4983138+noelmiller@users.noreply.github.com> Date: Tue, 20 Feb 2024 14:46:51 -0600 Subject: [PATCH 32/44] fix: Update LICENSE to Apache 2.0 --- LICENSE | 875 +++++++++++++------------------------------------------- 1 file changed, 201 insertions(+), 674 deletions(-) diff --git a/LICENSE b/LICENSE index f288702..261eeb9 100644 --- a/LICENSE +++ b/LICENSE @@ -1,674 +1,201 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. From 42d68772a0187f69848b438e5813e60f1570fcb0 Mon Sep 17 00:00:00 2001 From: Noel Miller <4983138+noelmiller@users.noreply.github.com> Date: Tue, 20 Feb 2024 16:36:12 -0600 Subject: [PATCH 33/44] feat(ci): Added ability to run the workflow manually and fix: general fixes (#17) --- .github/workflows/build-container-image.yml | 3 ++- Containerfile | 7 +++++-- Makefile | 6 +++--- README.md | 15 +++++++++------ xorriso/gen_input.sh.in | 11 +++++------ 5 files changed, 24 insertions(+), 18 deletions(-) diff --git a/.github/workflows/build-container-image.yml b/.github/workflows/build-container-image.yml index 0c17baa..fc6eff5 100644 --- a/.github/workflows/build-container-image.yml +++ b/.github/workflows/build-container-image.yml @@ -7,6 +7,7 @@ on: push: branches: - main + workflow_dispatch: jobs: push-image: @@ -49,4 +50,4 @@ jobs: run: exit 1 - name: Exit shell: bash - run: exit 0 \ No newline at end of file + run: exit 0 diff --git a/Containerfile b/Containerfile index e5f3d74..5d20332 100644 --- a/Containerfile +++ b/Containerfile @@ -1,7 +1,11 @@ +# Used by buildah build --build-arg to create multiple different versions of the image ARG VERSION=39 FROM fedora:${VERSION} +# Set version for the environment variables in the container. +ARG VERSION=39 + ENV ARCH="x86_64" ENV IMAGE_NAME="base-main" ENV IMAGE_REPO="ghcr.io/ublue-os" @@ -17,5 +21,4 @@ RUN dnf install -y make && make install-deps VOLUME /isogenerator/output -ENTRYPOINT ["make", "output/${IMAGE_NAME}-${IMAGE_TAG}.iso"] -CMD [ "ARCH=${ARCH}", "VERSION=${VERSION}", "IMAGE_REPO=${IMAGE_REPO}", "IMAGE_NAME=${IMAGE_NAME}", "IMAGE_TAG=${IMAGE_TAG}", "VARIANT=${VARIANT}", "WEB_UI=${WEB_UI}"] +ENTRYPOINT ["sh", "-c", "make output/${IMAGE_NAME}-${IMAGE_TAG}.iso ARCH=${ARCH} VERSION=${VERSION} IMAGE_REPO=${IMAGE_REPO} IMAGE_NAME=${IMAGE_NAME} IMAGE_TAG=${IMAGE_TAG} VARIANT=${VARIANT} WEB_UI=${WEB_UI}"] diff --git a/Makefile b/Makefile index b189d20..f49c8cb 100644 --- a/Makefile +++ b/Makefile @@ -31,7 +31,7 @@ $(IMAGE_NAME)-$(IMAGE_TAG).iso: output/$(IMAGE_NAME)-$(IMAGE_TAG).iso # Step 6: Build end ISO file output/$(IMAGE_NAME)-$(IMAGE_TAG).iso: boot.iso container/$(IMAGE_NAME)-$(IMAGE_TAG) xorriso/input.txt - mkdir $(_BASE_DIR)/output + mkdir $(_BASE_DIR)/output || true xorriso -dialog on < $(_BASE_DIR)/xorriso/input.txt # Step 1: Generate Lorax Templates @@ -48,7 +48,7 @@ lorax_templates/%.tmpl: lorax_templates/%.tmpl.in boot.iso: lorax_templates/set_installer.tmpl lorax_templates/configure_upgrades.tmpl rm -Rf $(_BASE_DIR)/results lorax -p $(IMAGE_NAME) -v $(VERSION) -r $(VERSION) -t $(VARIANT) \ - --isfinal --buildarch=$(ARCH) --volid=$(IMAGE_NAME)-$(ARCH)-$(VERSION) \ + --isfinal --buildarch=$(ARCH) --volid=$(IMAGE_NAME)-$(ARCH)-$(IMAGE_TAG) \ $(_LORAX_ARGS) \ --repo /etc/yum.repos.d/fedora.repo \ --repo /etc/yum.repos.d/fedora-updates.repo \ @@ -59,7 +59,7 @@ boot.iso: lorax_templates/set_installer.tmpl lorax_templates/configure_upgrades. # Step 3: Download container image container/$(IMAGE_NAME)-$(IMAGE_TAG): - mkdir container + mkdir container || true podman pull $(IMAGE_REPO)/$(IMAGE_NAME):$(IMAGE_TAG) podman save --format oci-dir -o $(_BASE_DIR)/container/$(IMAGE_NAME)-$(IMAGE_TAG) $(IMAGE_REPO)/$(IMAGE_NAME):$(IMAGE_TAG) podman rmi $(IMAGE_REPO)/$(IMAGE_NAME):$(IMAGE_TAG) diff --git a/README.md b/README.md index b3575d0..ea30e20 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # UBlueOS ISO Generator This action is used to generate the ISO images for UBlueOS. - ## Makefile 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. @@ -10,17 +9,21 @@ See [Customizing](#customizing) for information about customizing the image that ## Container A container with the necessary tools already installed is provided at `ghcr.io/ublue-os/isogenerator:latest` -To use the container file, run `docker --privileged --volume .:/isogenerator/output ghcr.io/ublue-os/isogenerator` +To use the container file, run `docker run --privileged --volume .:/isogenerator/output ghcr.io/ublue-os/isogenerator`. + +This will create an ISO with the baked in defaults of the container image. 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: -Environment Variable + +Creating Bluefin GTS ISO ```bash -docker --privileged --volume .:/isogenerator/output -e VERSION=39 ghcr.io/ublue-os/isogenerator +docker run --rm --privileged --volume .:/isogenerator/output -e VERSION=38 -e IMAGE_NAME=bluefin -e IMAGE_TAG=gts -e VARIANT=Silverblue ghcr.io/ublue-os/isogenerator:38 ``` -Command Argument + +Creating Bazzite Latest ISO ```bash -docker --privileged --volume .:/isogenerator/output ghcr.io/ublue-os/isogenerator VERSION=39 +docker run --rm --privileged --volume .:/isogenerator/output -e VERSION=39 -e IMAGE_NAME=bazzite -e IMAGE_TAG=latest -e VARIANT=Kinoite ghcr.io/ublue-os/isogenerator:39 ``` ## Customizing diff --git a/xorriso/gen_input.sh.in b/xorriso/gen_input.sh.in index 30d73fa..76d419e 100644 --- a/xorriso/gen_input.sh.in +++ b/xorriso/gen_input.sh.in @@ -3,13 +3,12 @@ echo "-indev $(pwd)/boot.iso" echo "-outdev $(pwd)/output/@IMAGE_NAME@-@IMAGE_TAG@.iso" echo "-boot_image any replay" -echo "-volid @IMAGE_NAME@-@ARCH@-@IMAGE_TAG@" echo "-joliet on" echo "-compliance joliet_long_names" cd container -for file in $(find @IMAGE_NAME@-@IMAGE_TAG@) -do - echo "-map $(pwd)/${file} ${file}" - echo "-chmod 0444 ${file}" +for file in $(find @IMAGE_NAME@-@IMAGE_TAG@); do + echo "-map $(pwd)/${file} ${file}" + echo "-chmod 0444 ${file}" done -echo "-end" \ No newline at end of file +echo "-end" + From 5e5ce9e7546bad5384b8f15a47f094526a333dd0 Mon Sep 17 00:00:00 2001 From: "Jason N." <33561705+JasonN3@users.noreply.github.com> Date: Wed, 21 Feb 2024 15:25:11 -0500 Subject: [PATCH 34/44] fix: make volid shorter to fit within 32 char --- Makefile | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Makefile b/Makefile index f49c8cb..1741532 100644 --- a/Makefile +++ b/Makefile @@ -13,6 +13,7 @@ WEB_UI = false _BASE_DIR = $(shell pwd) _IMAGE_REPO_ESCAPED = $(subst /,\/,$(IMAGE_REPO)) _IMAGE_REPO_DOUBLE_ESCAPED = $(subst \,\\\,$(_IMAGE_REPO_ESCAPED)) +_VOLID = $(IMAGE_NAME:-%=)-$(ARCH)-$(IMAGE_TAG) ifeq ($(VARIANT),'Server') _LORAX_ARGS = --macboot --noupgrade @@ -48,7 +49,7 @@ lorax_templates/%.tmpl: lorax_templates/%.tmpl.in boot.iso: lorax_templates/set_installer.tmpl lorax_templates/configure_upgrades.tmpl rm -Rf $(_BASE_DIR)/results lorax -p $(IMAGE_NAME) -v $(VERSION) -r $(VERSION) -t $(VARIANT) \ - --isfinal --buildarch=$(ARCH) --volid=$(IMAGE_NAME)-$(ARCH)-$(IMAGE_TAG) \ + --isfinal --buildarch=$(ARCH) --volid=$(_VOLID) \ $(_LORAX_ARGS) \ --repo /etc/yum.repos.d/fedora.repo \ --repo /etc/yum.repos.d/fedora-updates.repo \ From a988f745237abc0d2af063a23e1c52a53c8a205a Mon Sep 17 00:00:00 2001 From: "Jason N." <33561705+JasonN3@users.noreply.github.com> Date: Wed, 21 Feb 2024 15:46:27 -0500 Subject: [PATCH 35/44] fix: only get first portion of image_name --- Makefile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index 1741532..09e90a8 100644 --- a/Makefile +++ b/Makefile @@ -4,7 +4,7 @@ ARCH = x86_64 VERSION = 39 IMAGE_REPO = ghcr.io/ublue-os IMAGE_NAME = base-main -IMAGE_TAG = $(version) +IMAGE_TAG = $(VERSION) VARIANT = Kinoite WEB_UI = false @@ -13,7 +13,7 @@ WEB_UI = false _BASE_DIR = $(shell pwd) _IMAGE_REPO_ESCAPED = $(subst /,\/,$(IMAGE_REPO)) _IMAGE_REPO_DOUBLE_ESCAPED = $(subst \,\\\,$(_IMAGE_REPO_ESCAPED)) -_VOLID = $(IMAGE_NAME:-%=)-$(ARCH)-$(IMAGE_TAG) +_VOLID = $(firstword $(subst -, ,$(IMAGE_NAME)))-$(ARCH)-$(IMAGE_TAG) ifeq ($(VARIANT),'Server') _LORAX_ARGS = --macboot --noupgrade From bf4d1368fcdab9bcb7f594868c5791197ce0d797 Mon Sep 17 00:00:00 2001 From: Noel Miller <4983138+noelmiller@users.noreply.github.com> Date: Fri, 23 Feb 2024 12:10:17 -0600 Subject: [PATCH 36/44] feat: Add Secure Boot Support and Remove Grub Entry for Test this Media (#28) * chore: First pass of adding secure boot key enrollment * feat: Add secure boot support * feat: Removed Test this media grub entry and set default to install * fix: simplify secureboot scripts --------- Co-authored-by: Kyle Gospodnetich --- Makefile | 6 ++++++ lorax_templates/secure_boot_key.tmpl | 9 +++++++++ scripts/enroll-secureboot-key.sh | 19 +++++++++++++++++++ scripts/ublue-os-akmods-public-key.der | Bin 0 -> 1548 bytes xorriso/gen_input.sh.in | 5 ++++- 5 files changed, 38 insertions(+), 1 deletion(-) create mode 100644 lorax_templates/secure_boot_key.tmpl create mode 100755 scripts/enroll-secureboot-key.sh create mode 100644 scripts/ublue-os-akmods-public-key.der diff --git a/Makefile b/Makefile index 09e90a8..56de4cc 100644 --- a/Makefile +++ b/Makefile @@ -48,6 +48,11 @@ lorax_templates/%.tmpl: lorax_templates/%.tmpl.in # Step 2: Build boot.iso using Lorax boot.iso: lorax_templates/set_installer.tmpl lorax_templates/configure_upgrades.tmpl rm -Rf $(_BASE_DIR)/results + sed -i '/menuentry '\''Test this media & install @PRODUCT@ @VERSION@'\'' --class fedora --class gnu-linux --class gnu --class os {/,/}/d' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-bios.cfg + sed -i '/menuentry '\''Test this media & install @PRODUCT@ @VERSION@'\'' --class fedora --class gnu-linux --class gnu --class os {/,/}/d' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-efi.cfg + sed -i 's/set default="1"/set default="0"/' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-bios.cfg + sed -i 's/set default="1"/set default="0"/' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-efi.cfg + lorax -p $(IMAGE_NAME) -v $(VERSION) -r $(VERSION) -t $(VARIANT) \ --isfinal --buildarch=$(ARCH) --volid=$(_VOLID) \ $(_LORAX_ARGS) \ @@ -55,6 +60,7 @@ boot.iso: lorax_templates/set_installer.tmpl lorax_templates/configure_upgrades. --repo /etc/yum.repos.d/fedora-updates.repo \ --add-template $(_BASE_DIR)/lorax_templates/set_installer.tmpl \ --add-template $(_BASE_DIR)/lorax_templates/configure_upgrades.tmpl \ + --add-template $(_BASE_DIR)/lorax_templates/secure_boot_key.tmpl \ $(_BASE_DIR)/results/ mv $(_BASE_DIR)/results/images/boot.iso $(_BASE_DIR)/ diff --git a/lorax_templates/secure_boot_key.tmpl b/lorax_templates/secure_boot_key.tmpl new file mode 100644 index 0000000..e0c9809 --- /dev/null +++ b/lorax_templates/secure_boot_key.tmpl @@ -0,0 +1,9 @@ +append usr/share/anaconda/interactive-defaults.ks "%post --logfile=/root/ks-post.log --erroronfail --nochroot" +append usr/share/anaconda/interactive-defaults.ks "set -m" +append usr/share/anaconda/interactive-defaults.ks "/run/install/repo/enroll-secureboot-key.sh" +append usr/share/anaconda/interactive-defaults.ks "%end" + +append usr/share/anaconda/post-scripts/secure_boot_key.ks "%post --logfile=/root/ks-post.log --erroronfail --nochroot" +append usr/share/anaconda/post-scripts/secure_boot_key.ks "set -m" +append usr/share/anaconda/post-scripts/secure_boot_key.ks "/run/install/repo/enroll-secureboot-key.sh" +append usr/share/anaconda/post-scripts/secure_boot_key.ks "%end" diff --git a/scripts/enroll-secureboot-key.sh b/scripts/enroll-secureboot-key.sh new file mode 100755 index 0000000..1e74f40 --- /dev/null +++ b/scripts/enroll-secureboot-key.sh @@ -0,0 +1,19 @@ +#!/bin/sh + +set -oue pipefail + +readonly SECUREBOOT_KEY="/run/install/repo/ublue-os-akmods-public-key.der" +readonly ENROLLMENT_PASSWORD="ublue-os" + +if [[ ! -d "/sys/firmware/efi" ]]; then + echo "EFI mode not detected. Skipping key enrollment." + exit 0 +fi + +if [[ ! -f "${SECUREBOOT_KEY}" ]]; then + echo "Secure boot key not found: ${SECUREBOOT_KEY}" + exit 1 +fi + +mokutil --timeout -1 || : +echo -e "${ENROLLMENT_PASSWORD}\n${ENROLLMENT_PASSWORD}" | mokutil --import "${SECUREBOOT_KEY}" || : diff --git a/scripts/ublue-os-akmods-public-key.der b/scripts/ublue-os-akmods-public-key.der new file mode 100644 index 0000000000000000000000000000000000000000..a2ee4477b594f1a9670b00cd4d4944e20bbfdc47 GIT binary patch literal 1548 zcmXqLV&gDqV*apznTe5!NyL#SS6w*FGqmjfi-jdimMH1X;F@T_%f_kI=F#?@mywa1 zmBFBKo}svbC>wJq3l|SxXkKPnYEf}wj)GH8X{sSVP%%(~n};niJ2yY2*ih9#8Lpd? zQA{i=zbHLbFFCQeq$uAZJvT8kM=v=)*O1qM8>Ek&hs7^HFBQh+fO5GFI6<;(!b}kn zh6)C9APzH+IK&Etocv^<^~IU#d6{|X3eJuOa^k#3#s;Q_=7y%m2FAuw;=INnt_hSo z_&w0Xq=X#kjI0dIO-%d@22D&{OifIT43~Pv7p!VTOHIM=vs&{$)_@Ts&@#q2fin`-9cgn$xsp+dcoFinO^$FBsk^^LrZoz9;_QDcjA4 zZ8~;mJl^+An*PGj{PD*9ZoZ$_tP;65+lSTWnq9uFu3e20N4Uk-$!@nRt@S3Ie6wr9 z&kK9%4=XXUHr4lwZ}6S2mGJ^`s6s;|&&15gz_{4P zz{-FJm=$D&85#exFc~m_^N=h*3kx$7dxL>2NQ#d|j78-A^cgapU;pp8Sdsc*1H)G7 z$W!*l$mt81se$Q>kzvbK8^;6{H|OdLk4v9avWjONPk8rARF@;-altGf1+&@Z+kIIN zt~+qbk8w?2;L|r2CCiI!ejZ;T$i)1EIe*SS$7%D9d{USC`{lZTMyu(nDK2g=at^cV zZ}_FGsx?2J)7o_AmBlfMThilstUqe;I`=c4czExeYrdl*Px$k-LR0zmsk*b06imss1nHe9_C5W4z4HU5&qFf0|T>xU|lfdCl{W&bb<$+dpmDztS_Z z*UilL3fp~eebXe~u61}#$Al#>M3hf0bb0N5-*RGLM*4Gw{XE~b`fmHhIbM#|v2|X1 z{PG^b*OOf)3ja@D;`q|AYx!;Al~=CHy*9nI%;%<7^|r4u8_#~MT^hfa?NG+cHIGgz z&Qm(R?x)6_vcPKB^fZZ0+uFPIE93SRyZ(A@yLjF7YZ;s6VpPlbZmw7v^yKa=OX<4i z*PbQS?F_;kw%#exh`d=UE@Z5>f?Atbb^^0W2V=QN~ig$3F nR@r~? Date: Fri, 23 Feb 2024 18:55:44 -0600 Subject: [PATCH 37/44] feat: add creation of sha256 checksum (#30) * feat: add creation of sha256 checksum * fix: use it use no directory as part of the check --- action.yml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/action.yml b/action.yml index c08f1ee..a72a177 100644 --- a/action.yml +++ b/action.yml @@ -105,7 +105,7 @@ runs: VERSION=${{ inputs.VERSION }} \ WEB_UI=${{ inputs.WEB_UI }} - - name: Create deploy.iso + - name: Create deploy.iso and generate sha256 checksum shell: bash run: | make ${{ inputs.IMAGE_NAME }}-${{ inputs.IMAGE_TAG || inputs.VERSION }}.iso \ @@ -117,13 +117,14 @@ runs: VERSION=${{ inputs.VERSION }} \ WEB_UI=${{ inputs.WEB_UI }} mkdir end_iso + sha256sum ${{ inputs.IMAGE_NAME }}-${{ inputs.IMAGE_TAG || inputs.VERSION }}.iso > ./end_iso/${{ inputs.IMAGE_NAME }}-${{ inputs.IMAGE_TAG || inputs.VERSION }}-CHECKSUM mv ${{ inputs.IMAGE_NAME }}-${{ inputs.IMAGE_TAG || inputs.VERSION }}.iso end_iso/ - name: Upload ISO as artifact uses: actions/upload-artifact@v4 with: - name: ${{ inputs.IMAGE_NAME }}-${{ inputs.IMAGE_TAG || inputs.VERSION }}-${{ inputs.VARIANT }}.iso - path: end_iso/*.iso + name: ${{ inputs.IMAGE_NAME }}-${{ inputs.IMAGE_TAG || inputs.VERSION }}.iso + path: end_iso/* if-no-files-found: error retention-days: 0 compression-level: 0 From bdbcfde826d86df498bfa0a04995fa48547566d6 Mon Sep 17 00:00:00 2001 From: Benjamin Sherman Date: Fri, 23 Feb 2024 22:42:02 -0600 Subject: [PATCH 38/44] fix: use correct secureboot AKMOD_PRIVKEY_20230518 (#31) The very short-lived key AKMOD_PRIVKEY_20230517 was accidentally included here instead of the proper one. This correct key is the one we actually use to sign akmods (and also is used by bazzite to sign the whole kernel). So we definitely need this to be correct. --- scripts/ublue-os-akmods-public-key.der | Bin 1548 -> 1528 bytes 1 file changed, 0 insertions(+), 0 deletions(-) diff --git a/scripts/ublue-os-akmods-public-key.der b/scripts/ublue-os-akmods-public-key.der index a2ee4477b594f1a9670b00cd4d4944e20bbfdc47..98507ab7602836a1866c07b492516cde8894cfd3 100644 GIT binary patch delta 1229 zcmV;;1Ty=K4EPH*FoFg2FoFZzpaTK{0s<5lZan64+GMu$Cogl7^`vh+&W1KH4F(A+ zhDe6@4FLfQ1pqLCl#%v*Iu|GhX<5NMf|6six>A@-ax7Vrtuqwv?^1pue8&H@olN^X+^&6YLYErJj;Q1f0wE6 z(k#yP3o(;gY9FeS4pr{ns}{#^b4tHHb=Nff;pF%E$RRX~%!C4`K|T&{2^xcHSV! zV%4c$Ut9T(Kg$xL_63M>B9!R4$Z8>|QI>!AKP9f)i>HW~R~)A8i>6ZMJ7iX|!h6#eh)JB&UqGW@ia?WBK% zzA8PY{U^_Q%gnR9({rptbwbc1aJ5RcpC?wM_fdNqq%WKM_;HNUNW4 zf3HxSz+~j7H3?A0f5f3(V@(aspx{9MDuWLcEKP$Aw_QByc zQ1(t_Z(|pjlO{F@V#;Osji^nVDo5}gGMY=ag>|0>xFbxI?Duzgg_YDC73k3iJf&u{mubCwQc`-zR z?5`JPc1l5H>}}t9yilVvBsH*!^|az(pH7;+PtFq259LcOLqVdC+r<(T9XCz+)cUMv z(pVc=OxbY}7U4RVsy|wh?Y>Qf8$rATkwjO2u_@)<8Wkq=fEqRDDuqQga^E(AP|Er_ z+g)?+;2ZCkX|MS20yU5oyJW^NW9uOl##B4sk)CZHVMwXz8S~?^&t>|4&Mp#*XYS^n zy8{U+>Q!>0(Lz3KPv5`VJ)f4qH97JJ4elCnS0nhT8+9;|Wo3D>HY`Jj(gWcd6&hRhzJrNNv=+IT|JQQCKjRqbF%P|xj7Lv%RWcaw*Wm~c#|5(0P?#to9uM= zHwm<%#zPn+88yk&fx|sCVODK?nkS3yde1$%*VU}n)W#&|9iF%fojrV4IylNK&X2oM r*MmALqRYe z7Y#BqFf}nZF*P$VGc#Hj4Kp(^H8C_XH8U_XGg>f#o{{W*As{dw1_MMmALqU^(0U>|VjTfS=lN^OEeuQvP(h6|^sp~O3&NW;}9O7r6 zzCYYirw(1SswdBuLib7MS(D|FjulV%W)9baGK4G2d~|CLh{?z|jDgZLPOgt%l_8<9 z3*ZT?MzAQXGyw8-i6l0_f+yfotXeLU2I5*8XEgjsaTFSBu3hsIX1xzm2-AP+EyOIf z^xaXal$i3C{vXq=_ysjP2{nYa-cM3^W}U^*G1zuaFMwWX6@zE6GLS;AckF!o-Kj!%j1N?}iA zsKNhg2W#Q4$Jg0eU-c|QSTHEJ4QiyHgfSrZU34zX9Ejf2_aNLNr1mazmmMb%A3PBH z1|*-UAU&=Z`TN;!Z9R;rZ$(jAmoz$yb61L~o}AnmeUs5Kpm!n`=JJ=>rSmSV-OdvL!cehOi!LGo{ zP64cLQRVD7bffdw2$A z+niJqc=wgbqFq~`)X@GhR#aruXq3mr$=euZcWlr%HUq!%4a$-FWU194IU|<{>;g5L zs&yxun;clhks@-L@yE~RVSGh@uhds2fTJ*9mQOmYYA{_7UUqO4RhyUVa!PH^@gKG& z|8@!JjS6ftrang|4|Km~8i*GgEcBj(pT(TjTWyb)rv7!z9oIHDy%Rq7h3tYChbqIY zh>)b{6eG%^MC(W2IgwFlXXhZl4EHLI+fH6V(_1V(L#@Ztyb9jdxroM2-{fIAkHron-L~C47aA# zX;hI%FZJRq4BT8Pj<%aDtLS3^#sti2bGQi0B)`$|muRC1$L~zx5Pi54$e7DdTmuF# LP7;^|E4*v*POv|{ From ff58b2d1226c3a57d0353d55a15856f3dcc3f601 Mon Sep 17 00:00:00 2001 From: Kyle Gospodnetich Date: Sat, 24 Feb 2024 17:34:23 -0800 Subject: [PATCH 39/44] fix: Ignore Valve Steam Deck hardware due to using EFI but having no keys enrolled by default and add extra boot parameters (#33) * fix: Ignore Valve Steam Deck hardware due to using EFI but having no keys enrolled by default. * fix: add extra boot parameters to fix steam deck resolution issue --------- Co-authored-by: Noel Miller --- Makefile | 15 +++++++++++++++ action.yml | 4 ++++ scripts/enroll-secureboot-key.sh | 6 ++++++ 3 files changed, 25 insertions(+) diff --git a/Makefile b/Makefile index 56de4cc..697c721 100644 --- a/Makefile +++ b/Makefile @@ -5,6 +5,7 @@ VERSION = 39 IMAGE_REPO = ghcr.io/ublue-os IMAGE_NAME = base-main IMAGE_TAG = $(VERSION) +EXTRA_BOOT_PARAMS = VARIANT = Kinoite WEB_UI = false @@ -48,11 +49,25 @@ lorax_templates/%.tmpl: lorax_templates/%.tmpl.in # Step 2: Build boot.iso using Lorax boot.iso: lorax_templates/set_installer.tmpl lorax_templates/configure_upgrades.tmpl rm -Rf $(_BASE_DIR)/results + + # Remove the "Test this media & install" menu entry sed -i '/menuentry '\''Test this media & install @PRODUCT@ @VERSION@'\'' --class fedora --class gnu-linux --class gnu --class os {/,/}/d' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-bios.cfg sed -i '/menuentry '\''Test this media & install @PRODUCT@ @VERSION@'\'' --class fedora --class gnu-linux --class gnu --class os {/,/}/d' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-efi.cfg + + # Set the default menu entry to the first one sed -i 's/set default="1"/set default="0"/' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-bios.cfg sed -i 's/set default="1"/set default="0"/' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-efi.cfg + # Add Extra Boot Parameters to all menu entries + sed -i 's/linux @KERNELPATH@ @ROOT@ quiet/linux @KERNELPATH@ @ROOT@ quiet $(EXTRA_BOOT_PARAMS)/g' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-bios.cfg + sed -i 's/linuxefi @KERNELPATH@ @ROOT@ quiet/linuxefi @KERNELPATH@ @ROOT@ quiet $(EXTRA_BOOT_PARAMS)/g' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-efi.cfg + + sed -i 's/linux @KERNELPATH@ @ROOT@ nomodeset quiet/linux @KERNELPATH@ @ROOT@ nomodeset quiet $(EXTRA_BOOT_PARAMS)/g' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-bios.cfg + sed -i 's/linuxefi @KERNELPATH@ @ROOT@ nomodeset quiet/linuxefi @KERNELPATH@ @ROOT@ nomodeset quiet $(EXTRA_BOOT_PARAMS)/g' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-efi.cfg + + sed -i 's/linux @KERNELPATH@ @ROOT@ inst.rescue quiet/linux @KERNELPATH@ @ROOT@ inst.rescue quiet $(EXTRA_BOOT_PARAMS)/g' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-bios.cfg + sed -i 's/linuxefi @KERNELPATH@ @ROOT@ inst.rescue quiet/linuxefi @KERNELPATH@ @ROOT@ inst.rescue quiet $(EXTRA_BOOT_PARAMS)/g' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-efi.cfg + lorax -p $(IMAGE_NAME) -v $(VERSION) -r $(VERSION) -t $(VARIANT) \ --isfinal --buildarch=$(ARCH) --volid=$(_VOLID) \ $(_LORAX_ARGS) \ diff --git a/action.yml b/action.yml index a72a177..c422201 100644 --- a/action.yml +++ b/action.yml @@ -25,6 +25,9 @@ inputs: IMAGE_TAG: description: Tag of the source container image required: false + EXTRA_BOOT_PARAMS: + description: Extra params used by grub to boot the anaconda installer + required: false WEB_UI: description: Enable Anaconda WebUI required: true @@ -104,6 +107,7 @@ runs: VARIANT=${{ inputs.VARIANT }} \ VERSION=${{ inputs.VERSION }} \ WEB_UI=${{ inputs.WEB_UI }} + EXTRA_BOOT_PARAMS=${{ inputs.EXTRA_BOOT_PARAMS }} - name: Create deploy.iso and generate sha256 checksum shell: bash diff --git a/scripts/enroll-secureboot-key.sh b/scripts/enroll-secureboot-key.sh index 1e74f40..df91def 100755 --- a/scripts/enroll-secureboot-key.sh +++ b/scripts/enroll-secureboot-key.sh @@ -5,6 +5,12 @@ set -oue pipefail readonly SECUREBOOT_KEY="/run/install/repo/ublue-os-akmods-public-key.der" readonly ENROLLMENT_PASSWORD="ublue-os" +SYS_ID="$(cat /sys/devices/virtual/dmi/id/product_name)" +if [[ ":Jupiter:Galileo:" =~ ":$SYS_ID:" ]]; then + echo "Steam Deck hardware detected. Skipping key enrollment." + exit 0 +fi + if [[ ! -d "/sys/firmware/efi" ]]; then echo "EFI mode not detected. Skipping key enrollment." exit 0 From e36da208a85c42dff07a95aafd80c6decfa52be8 Mon Sep 17 00:00:00 2001 From: Noel Miller <4983138+noelmiller@users.noreply.github.com> Date: Sun, 25 Feb 2024 08:19:17 -0600 Subject: [PATCH 40/44] fix: missed \ and updated README (#34) * fix: missed \ * fix: moved variables into table and added EXTRA_BOOT_PARAMS * Update README.md Co-authored-by: Robert Sturla --------- Co-authored-by: Robert Sturla --- README.md | 35 +++++++++++++---------------------- action.yml | 2 +- 2 files changed, 14 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index ea30e20..e6ceee2 100644 --- a/README.md +++ b/README.md @@ -29,28 +29,19 @@ docker run --rm --privileged --volume .:/isogenerator/output -e VERSION=39 -e IM ## Customizing The following variables can be used to customize the create image. -- ARCH - Architecture for image to build - Default Value: x86_64 -- VERSION - Fedora version of installer to build - Default Value: 39 -- IMAGE_REPO - Repository containing the source container image - Default Value: ghcr.io/ublue-os -- IMAGE_NAME - Name of the source container image - Default Value: base-main -- IMAGE_TAG - Tag of the source container image - Default Value: *VERSION* -- VARIANT - Source container variant - Available options 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 kinonite - Default Value: Silverblue -- WEB_UI - Enable Anaconda WebUI - Default Value: false +| Variable | Description | Default Value | +| ----------------- | -------------------------------------------------------- | ---------------------- | +| ARCH | Architecture for image to build | x86_64 | +| VERSION | Fedora version of installer to build | 39 | +| IMAGE_REPO | Repository containing the source container image | ghcr.io/ublue-os | +| IMAGE_NAME | Name of the source container image | base-main | +| IMAGE_TAG | Tag of the source container image | *VERSION* | +| EXTRA_BOOT_PARAMS | Extra params used by grub to boot the anaconda installer | \[empty\] | +| VARIANT | Source container variant\* | Kinoite | +| WEB_UI | Enable Anaconda WebUI (experimental) | false | + +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 ## 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/ublue-os/isogenerator`, 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. diff --git a/action.yml b/action.yml index c422201..83438cd 100644 --- a/action.yml +++ b/action.yml @@ -106,7 +106,7 @@ runs: IMAGE_TAG=${{ inputs.IMAGE_TAG || inputs.VERSION }} \ VARIANT=${{ inputs.VARIANT }} \ VERSION=${{ inputs.VERSION }} \ - WEB_UI=${{ inputs.WEB_UI }} + WEB_UI=${{ inputs.WEB_UI }} \ EXTRA_BOOT_PARAMS=${{ inputs.EXTRA_BOOT_PARAMS }} - name: Create deploy.iso and generate sha256 checksum From 99a54d28696afa1c67bdfe806d5722913adecaa3 Mon Sep 17 00:00:00 2001 From: Robert Sturla Date: Tue, 27 Feb 2024 02:47:28 +0000 Subject: [PATCH 41/44] chore: remove unused rpm-ostree package (#27) chore: remove unused rpm-ostree dependency Co-authored-by: Noel Miller <4983138+noelmiller@users.noreply.github.com> --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 697c721..e946844 100644 --- a/Makefile +++ b/Makefile @@ -87,7 +87,7 @@ container/$(IMAGE_NAME)-$(IMAGE_TAG): podman rmi $(IMAGE_REPO)/$(IMAGE_NAME):$(IMAGE_TAG) install-deps: - dnf install -y lorax xorriso podman git rpm-ostree + dnf install -y lorax xorriso podman git # Step 4: Generate xorriso script xorriso/%.sh: xorriso/%.sh.in From 3401b10c5682be615e351c493b60997582f72db2 Mon Sep 17 00:00:00 2001 From: Benjamin Sherman Date: Tue, 27 Feb 2024 12:06:33 -0600 Subject: [PATCH 42/44] fix: make loop device during container build of ISO (#41) * fix: make loop device during container build of ISO This creates the loop device during container runtime which allows lorax to build the ISO and not need to rely on a host provided device file. Fixes: #22 * chore: updated readme --------- Co-authored-by: Noel Miller --- Containerfile | 2 +- README.md | 16 ++++++++++++---- entrypoint.sh | 8 ++++++++ 3 files changed, 21 insertions(+), 5 deletions(-) create mode 100755 entrypoint.sh diff --git a/Containerfile b/Containerfile index 5d20332..24e0954 100644 --- a/Containerfile +++ b/Containerfile @@ -21,4 +21,4 @@ RUN dnf install -y make && make install-deps VOLUME /isogenerator/output -ENTRYPOINT ["sh", "-c", "make output/${IMAGE_NAME}-${IMAGE_TAG}.iso ARCH=${ARCH} VERSION=${VERSION} IMAGE_REPO=${IMAGE_REPO} IMAGE_NAME=${IMAGE_NAME} IMAGE_TAG=${IMAGE_TAG} VARIANT=${VARIANT} WEB_UI=${WEB_UI}"] +ENTRYPOINT /isogenerator/entrypoint.sh diff --git a/README.md b/README.md index e6ceee2..6157d2d 100644 --- a/README.md +++ b/README.md @@ -16,14 +16,22 @@ This will create an ISO with the baked in defaults of the container image. 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: -Creating Bluefin GTS ISO +Creating Universal Blue Silverblue ISO ```bash -docker run --rm --privileged --volume .:/isogenerator/output -e VERSION=38 -e IMAGE_NAME=bluefin -e IMAGE_TAG=gts -e VARIANT=Silverblue ghcr.io/ublue-os/isogenerator:38 +docker run --rm --privileged --volume .:/isogenerator/output -e VERSION=39 -e IMAGE_NAME=silverblue-main -e IMAGE_TAG=latest -e VARIANT=Silverblue ghcr.io/ublue-os/isogenerator:39 +``` +```bash +# Requires sudo to run +sudo podman run --rm --privileged --volume .:/isogenerator/output -e VERSION=39 -e IMAGE_NAME=silverblue-main -e IMAGE_TAG=latest -e VARIANT=Silverblue ghcr.io/ublue-os/isogenerator:39 ``` -Creating Bazzite Latest ISO +Creating Universal Blue Kinoite ISO ```bash -docker run --rm --privileged --volume .:/isogenerator/output -e VERSION=39 -e IMAGE_NAME=bazzite -e IMAGE_TAG=latest -e VARIANT=Kinoite ghcr.io/ublue-os/isogenerator:39 +docker run --rm --privileged --volume .:/isogenerator/output -e VERSION=39 -e IMAGE_NAME=kinoite-main -e IMAGE_TAG=latest -e VARIANT=Kinoite ghcr.io/ublue-os/isogenerator:39 +``` +```bash +# Requires sudo to run +sudo podman run --rm --privileged --volume .:/isogenerator/output -e VERSION=39 -e IMAGE_NAME=kinoite-main -e IMAGE_TAG=latest -e VARIANT=Kinoite ghcr.io/ublue-os/isogenerator:39 ``` ## Customizing diff --git a/entrypoint.sh b/entrypoint.sh new file mode 100755 index 0000000..e254ae1 --- /dev/null +++ b/entrypoint.sh @@ -0,0 +1,8 @@ +#!/bin/bash + +set -eu + +# pre-create loop devices manually. In containers we can't use losetup for that. +mknod -m 0660 /dev/loop0 b 7 0 2> /dev/null || true + +make output/${IMAGE_NAME}-${IMAGE_TAG}.iso ARCH=${ARCH} VERSION=${VERSION} IMAGE_REPO=${IMAGE_REPO} IMAGE_NAME=${IMAGE_NAME} IMAGE_TAG=${IMAGE_TAG} VARIANT=${VARIANT} WEB_UI=${WEB_UI} From f70e8ea027edd0cf2678aeb03c5339d84aeaa744 Mon Sep 17 00:00:00 2001 From: Noel Miller <4983138+noelmiller@users.noreply.github.com> Date: Tue, 27 Feb 2024 18:06:38 -0600 Subject: [PATCH 43/44] feat: Allow users to override secure boot key and password (#40) * feat: Allow users to override secure boot key and password when using container or action * fix: follow redirects * chore: update docs * fix: added comments and removed additional \n * fix: removed defaults * fix: added conditional for adding public key * chore(ci): Added additional test for secure boot * chore(ci): fixed up workflows to match production * fix(ci): added workflow dispatch to test * fix(ci): fixed version and added IMAGE_TAG * chore(ci): changed to bluefin to test both 38 and 39 secure boot * chore(ci): added required variables to entrypoint * chore(ci): added merge_group and added paths-ignore * chore(ci): updated description * chore(ci): set to Silverblue since we are testing Bluefin * chore(ci): Fixed secure boot key not found error Received error in anaconda when check was hit, need to set as a soft failure to exit the script early without stopping anaconda installation. * chore: fixed formatting * chore: fixed whitespace * chore(ci): Removed duplicate test * chore: fix whitespace * chore(ci): fixed test and removed upload to Github Artifacts * chore: updated README * fix: set password to ublue default * fix: changed enrollment password in containerfile --- .github/workflows/build-container-image.yml | 5 +++ .github/workflows/test-iso.yml | 32 ++++++++++++++++-- Containerfile | 2 ++ Makefile | 11 ++++++ README.md | 29 +++++++++------- action.yml | 20 +++++------ entrypoint.sh | 13 +++++-- ...oot-key.sh => enroll-secureboot-key.sh.in} | 20 +++++------ scripts/ublue-os-akmods-public-key.der | Bin 1528 -> 0 bytes xorriso/gen_input.sh.in | 6 ++-- 10 files changed, 99 insertions(+), 39 deletions(-) rename scripts/{enroll-secureboot-key.sh => enroll-secureboot-key.sh.in} (73%) delete mode 100644 scripts/ublue-os-akmods-public-key.der diff --git a/.github/workflows/build-container-image.yml b/.github/workflows/build-container-image.yml index fc6eff5..48dbca7 100644 --- a/.github/workflows/build-container-image.yml +++ b/.github/workflows/build-container-image.yml @@ -1,9 +1,14 @@ --- name: Build Container Image on: + merge_group: pull_request: branches: - main + paths-ignore: + - '*.md' + - 'LICENSE' + - 'CODEOWNERS' push: branches: - main diff --git a/.github/workflows/test-iso.yml b/.github/workflows/test-iso.yml index 0465b1b..0d099d5 100644 --- a/.github/workflows/test-iso.yml +++ b/.github/workflows/test-iso.yml @@ -10,6 +10,7 @@ on: - '*.md' - 'LICENSE' - 'CODEOWNERS' + workflow_dispatch: jobs: build-and-push-iso: @@ -18,15 +19,30 @@ jobs: container: image: fedora:39 options: "--privileged" + volumes: + - "/:/host" permissions: contents: read packages: write strategy: fail-fast: false matrix: - version: + version: - 38 - 39 + secure_boot: + - true + - false + include: + - secure_boot: true + SECURE_BOOT_KEY_URL: 'https://github.com/ublue-os/akmods/raw/main/certs/public_key.der' + ENROLLMENT_PASSWORD: 'ublue-os' + SECURE_BOOT_STRING: '-secure' + - secure_boot: false + SECURE_BOOT_KEY_URL: '' + ENROLLMENT_PASSWORD: '' + SECURE_BOOT_STRING: '' + steps: - name: Checkout uses: actions/checkout@v4 @@ -41,6 +57,18 @@ jobs: VERSION: ${{ matrix.version }} ACTION_REPO: ${{ github.repository }} ACTION_REF: ${{ github.ref }} + SECURE_BOOT_KEY_URL: ${{ matrix.SECURE_BOOT_KEY_URL }} + ENROLLMENT_PASSWORD: ${{ matrix.ENROLLMENT_PASSWORD }} + + - name: Upload ISO as artifact + uses: actions/upload-artifact@v4 + with: + name: base-main-${{ matrix.version }}${{ matrix.SECURE_BOOT_STRING }}.iso + path: end_iso/* + if-no-files-found: error + retention-days: 0 + compression-level: 0 + overwrite: true check: name: Check build successful @@ -55,4 +83,4 @@ jobs: run: exit 1 - name: Exit shell: bash - run: exit 0 \ No newline at end of file + run: exit 0 diff --git a/Containerfile b/Containerfile index 24e0954..e0be396 100644 --- a/Containerfile +++ b/Containerfile @@ -13,6 +13,8 @@ ENV IMAGE_TAG="${VERSION}" ENV VARIANT="Kinoite" ENV VERSION="${VERSION}" ENV WEB_UI="false" +ENV SECURE_BOOT_KEY_URL="" +ENV ENROLLMENT_PASSWORD="ublue-os" COPY / /isogenerator WORKDIR /isogenerator diff --git a/Makefile b/Makefile index e946844..05dde54 100644 --- a/Makefile +++ b/Makefile @@ -8,6 +8,8 @@ IMAGE_TAG = $(VERSION) EXTRA_BOOT_PARAMS = VARIANT = Kinoite WEB_UI = false +ENROLLMENT_PASSWORD = ublue-os +SECURE_BOOT_KEY_URL = # Generated vars ## Formatting = _UPPERCASE @@ -50,6 +52,14 @@ lorax_templates/%.tmpl: lorax_templates/%.tmpl.in boot.iso: lorax_templates/set_installer.tmpl lorax_templates/configure_upgrades.tmpl rm -Rf $(_BASE_DIR)/results + # Set the enrollment password + sed 's/@ENROLLMENT_PASSWORD@/$(ENROLLMENT_PASSWORD)/' $(_BASE_DIR)/scripts/enroll-secureboot-key.sh.in > $(_BASE_DIR)/scripts/enroll-secureboot-key.sh + + # Download the secure boot key + if [ -n "$(SECURE_BOOT_KEY_URL)" ]; then\ + curl --fail -L -o $(_BASE_DIR)/sb_pubkey.der $(SECURE_BOOT_KEY_URL);\ + fi + # Remove the "Test this media & install" menu entry sed -i '/menuentry '\''Test this media & install @PRODUCT@ @VERSION@'\'' --class fedora --class gnu-linux --class gnu --class os {/,/}/d' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-bios.cfg sed -i '/menuentry '\''Test this media & install @PRODUCT@ @VERSION@'\'' --class fedora --class gnu-linux --class gnu --class os {/,/}/d' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-efi.cfg @@ -68,6 +78,7 @@ boot.iso: lorax_templates/set_installer.tmpl lorax_templates/configure_upgrades. sed -i 's/linux @KERNELPATH@ @ROOT@ inst.rescue quiet/linux @KERNELPATH@ @ROOT@ inst.rescue quiet $(EXTRA_BOOT_PARAMS)/g' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-bios.cfg sed -i 's/linuxefi @KERNELPATH@ @ROOT@ inst.rescue quiet/linuxefi @KERNELPATH@ @ROOT@ inst.rescue quiet $(EXTRA_BOOT_PARAMS)/g' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-efi.cfg + # Build boot.iso lorax -p $(IMAGE_NAME) -v $(VERSION) -r $(VERSION) -t $(VARIANT) \ --isfinal --buildarch=$(ARCH) --volid=$(_VOLID) \ $(_LORAX_ARGS) \ diff --git a/README.md b/README.md index 6157d2d..3f3e505 100644 --- a/README.md +++ b/README.md @@ -37,19 +37,24 @@ sudo podman run --rm --privileged --volume .:/isogenerator/output -e VERSION=39 ## Customizing The following variables can be used to customize the create image. -| Variable | Description | Default Value | -| ----------------- | -------------------------------------------------------- | ---------------------- | -| ARCH | Architecture for image to build | x86_64 | -| VERSION | Fedora version of installer to build | 39 | -| IMAGE_REPO | Repository containing the source container image | ghcr.io/ublue-os | -| IMAGE_NAME | Name of the source container image | base-main | -| IMAGE_TAG | Tag of the source container image | *VERSION* | -| EXTRA_BOOT_PARAMS | Extra params used by grub to boot the anaconda installer | \[empty\] | -| VARIANT | Source container variant\* | Kinoite | -| WEB_UI | Enable Anaconda WebUI (experimental) | false | +| Variable | Description | Default Value | +| ----------------- | ------------------------------------------------------------ | ---------------------- | +| ARCH | Architecture for image to build | x86_64 | +| VERSION | Fedora version of installer to build | 39 | +| IMAGE_REPO | Repository containing the source container image | ghcr.io/ublue-os | +| IMAGE_NAME | Name of the source container image | base-main | +| IMAGE_TAG | Tag of the source container image | *VERSION* | +| EXTRA_BOOT_PARAMS | Extra params used by grub to boot the anaconda installer | \[empty\] | +| VARIANT | Source container variant\* | Kinoite | +| WEB_UI | Enable Anaconda WebUI (experimental) | false | +| ENROLLMENT_PASSWORD | Password used to enroll secure boot key into BIOS\*\* | isogenerator | +| SECURE_BOOT_KEY_URL | URL used to download your secure boot key for enrollment\*\* | \[empty\] | -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 +\*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 + +\*\*NOTE: ENROLLMENT_PASSWORD and SECURE_BOOT_KEY_URL are not required. They are only required if you are creating specific kernel modules or if you are using Universal Blue Kernel Modules. + +Our public key for our kmods is located here: https://github.com/ublue-os/akmods/raw/main/certs/public_key.der ## 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/ublue-os/isogenerator`, 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. diff --git a/action.yml b/action.yml index 83438cd..a1ac5ed 100644 --- a/action.yml +++ b/action.yml @@ -32,6 +32,12 @@ inputs: description: Enable Anaconda WebUI required: true default: "false" + ENROLLMENT_PASSWORD: + description: Used for supporting secure boot (requires SECURE_BOOT_KEY_URL to be defined) + required: false + SECURE_BOOT_KEY_URL: + description: Secure boot key that is installed from URL location + required: false ACTION_REPO: description: Repository with the build action required: false @@ -107,7 +113,9 @@ runs: VARIANT=${{ inputs.VARIANT }} \ VERSION=${{ inputs.VERSION }} \ WEB_UI=${{ inputs.WEB_UI }} \ - EXTRA_BOOT_PARAMS=${{ inputs.EXTRA_BOOT_PARAMS }} + EXTRA_BOOT_PARAMS=${{ inputs.EXTRA_BOOT_PARAMS }} \ + SECURE_BOOT_KEY_URL=${{ inputs.SECURE_BOOT_KEY_URL }} \ + ENROLLMENT_PASSWORD=${{ inputs.ENROLLMENT_PASSWORD }} - name: Create deploy.iso and generate sha256 checksum shell: bash @@ -123,13 +131,3 @@ runs: mkdir end_iso sha256sum ${{ inputs.IMAGE_NAME }}-${{ inputs.IMAGE_TAG || inputs.VERSION }}.iso > ./end_iso/${{ inputs.IMAGE_NAME }}-${{ inputs.IMAGE_TAG || inputs.VERSION }}-CHECKSUM mv ${{ inputs.IMAGE_NAME }}-${{ inputs.IMAGE_TAG || inputs.VERSION }}.iso end_iso/ - - - name: Upload ISO as artifact - uses: actions/upload-artifact@v4 - with: - name: ${{ inputs.IMAGE_NAME }}-${{ inputs.IMAGE_TAG || inputs.VERSION }}.iso - path: end_iso/* - if-no-files-found: error - retention-days: 0 - compression-level: 0 - overwrite: true diff --git a/entrypoint.sh b/entrypoint.sh index e254ae1..27160e8 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -3,6 +3,15 @@ set -eu # pre-create loop devices manually. In containers we can't use losetup for that. -mknod -m 0660 /dev/loop0 b 7 0 2> /dev/null || true +mknod -m 0660 /dev/loop0 b 7 0 2>/dev/null || true -make output/${IMAGE_NAME}-${IMAGE_TAG}.iso ARCH=${ARCH} VERSION=${VERSION} IMAGE_REPO=${IMAGE_REPO} IMAGE_NAME=${IMAGE_NAME} IMAGE_TAG=${IMAGE_TAG} VARIANT=${VARIANT} WEB_UI=${WEB_UI} +make output/${IMAGE_NAME}-${IMAGE_TAG}.iso \ + ARCH=${ARCH} \ + VERSION=${VERSION} \ + IMAGE_REPO=${IMAGE_REPO} \ + IMAGE_NAME=${IMAGE_NAME} \ + IMAGE_TAG=${IMAGE_TAG} \ + VARIANT=${VARIANT} \ + WEB_UI=${WEB_UI} \ + SECURE_BOOT_KEY_URL=${SECURE_BOOT_KEY_URL} \ + ENROLLMENT_PASSWORD=${ENROLLMENT_PASSWORD} diff --git a/scripts/enroll-secureboot-key.sh b/scripts/enroll-secureboot-key.sh.in similarity index 73% rename from scripts/enroll-secureboot-key.sh rename to scripts/enroll-secureboot-key.sh.in index df91def..dd1fd4e 100755 --- a/scripts/enroll-secureboot-key.sh +++ b/scripts/enroll-secureboot-key.sh.in @@ -2,14 +2,8 @@ set -oue pipefail -readonly SECUREBOOT_KEY="/run/install/repo/ublue-os-akmods-public-key.der" -readonly ENROLLMENT_PASSWORD="ublue-os" - -SYS_ID="$(cat /sys/devices/virtual/dmi/id/product_name)" -if [[ ":Jupiter:Galileo:" =~ ":$SYS_ID:" ]]; then - echo "Steam Deck hardware detected. Skipping key enrollment." - exit 0 -fi +readonly ENROLLMENT_PASSWORD=@ENROLLMENT_PASSWORD@ +readonly SECUREBOOT_KEY="/run/install/repo/sb_pubkey.der" if [[ ! -d "/sys/firmware/efi" ]]; then echo "EFI mode not detected. Skipping key enrollment." @@ -17,8 +11,14 @@ if [[ ! -d "/sys/firmware/efi" ]]; then fi if [[ ! -f "${SECUREBOOT_KEY}" ]]; then - echo "Secure boot key not found: ${SECUREBOOT_KEY}" - exit 1 + echo "Secure boot key not provided: ${SECUREBOOT_KEY}" + exit 0 +fi + +SYS_ID="$(cat /sys/devices/virtual/dmi/id/product_name)" +if [[ ":Jupiter:Galileo:" =~ ":$SYS_ID:" ]]; then + echo "Steam Deck hardware detected. Skipping key enrollment." + exit 0 fi mokutil --timeout -1 || : diff --git a/scripts/ublue-os-akmods-public-key.der b/scripts/ublue-os-akmods-public-key.der deleted file mode 100644 index 98507ab7602836a1866c07b492516cde8894cfd3..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1528 zcmXqLV*O&!#C&G~GZP~dlZbep&9kCgDcioN>laV@x+LG`T$`BzFB_*;n@8JsUPeZ4 zRtAH{DTd+(qHN5eEL=Q%p?R5QsYS(!ISNiWrKyJeK*c}_ZXUM8?A-j6VnbB}Ww>rm zMlrFh{G#+!z2wB=lA?Tv^xVYE9KGcHTti+1Zje599u~j+yi^#M1Ipz#-~`FC2{T1R z7>XH)fH=%NyroG%D-|FXDHzC!^BNf&m>OCb85mm{nnj888iTl|Q0`!Lb`z5lasV^3 zGB7tW@iQ1SF>x_9F)=b6ZfBq3>H25+!fx^JvG*KSF)aHi-L^$5c=h@%mzzK4u6&>A zy6^TP=1xzu0TPUFpRK!R=4CJZuPK zyc^SWOhD+W?AFER^H-$@Y4oz6Pu=S%c75MR0i{zS)3%=#Q%K&scZaR{uAG8K$_AlCG|di;w=E zy4&5$J7$E-EPLC%Ea;haO4!CHucPKaNbzkwd&{*#(tznq;?y5Er))o{uAJgFV; z7~9qruL^8FWGC|X{Tu5ZJ3XU6Tc*BU(y~v>cG+L`^HrzMY~FLZc#U(Z(*@;%tzKK_ ztA{QA9#}24M1S`0AB8;^AMZQSb7XnciBF+E`St4q<{U_QvfPw2;8^{Ug|W%Lyk{3Y zaQLUytPmJt+|*f*o?El864Bnm$o5NfLVCf;#pYX|-a6ZNZ%ypNtMlDftq5m(K37uoyYlwT zy-I(CKTJ>N`?R$pWr_itm$=7cR<~JmM2fa@WF+n?5Da>E@huZGBLm}N8v`o?9$>PU z6=r1o&%$KD0M0M6{46ZYOzaH?vLGow7BLo)6IFMTx{qr=o_+G?2G?EY9&e%(o+GC( zU`}4}LHR+ckq$7Q977B_zw3@!kK5F9IeZDQyj(b=px`c1ke0o<( zRP9THl<9M=R#(%a`(}*+r+!)9jxB!oK>Gdk%=JIsGnq~h-JNpGAo;bT$gvRX`xEEo z$|ZWNd@1?)@uu^szv|BE33aExdp2)3GpFXO(4s{bo$PY_@9)25JAc{%Q_D~6yzit6 z!j*qq4c+uT?{f5K>rHny-I%@M@xI=;Nmbj}{JnDua-xNAKVHmsYm3l~Or@T{!(Xml z^$-n65Ze|kZ1`nieWqObKl{4F5AA|9KOd~yTPWuzx2Etb=k-<7elF+_P5HCulf&$* z=QNoNZgv>^88J=pvi$IB9k=T(`AsL5%Gr2{?KN!q(;iSQSX{@jwbNl@gXuvPg__8+ z$(4H7Po^Ht=CYV?C-7#QlAl2C^bg!pM-7eFaL%xaSLQfSIsNF&4h|uC&vkxfv9=T5 zsfjIODBkp8!cI#;)6;hDm$oz5##c<1I?nKExAE*ZCEv|Cw=6v7ETJN4dh$x+VOx{L zu-uwi>fP_E&fD(1es#^YE5}rx%g)=uHP^N#+{)tAx&GaOH Date: Tue, 27 Feb 2024 18:28:38 -0600 Subject: [PATCH 44/44] feat: Add Test Media Capability (#43) * feat: Allow users to override secure boot key and password when using container or action * fix: follow redirects * chore: update docs * fix: added comments and removed additional \n * fix: removed defaults * fix: added conditional for adding public key * chore(ci): Added additional test for secure boot * chore(ci): fixed up workflows to match production * fix(ci): added workflow dispatch to test * fix(ci): fixed version and added IMAGE_TAG * chore(ci): changed to bluefin to test both 38 and 39 secure boot * chore(ci): added required variables to entrypoint * chore(ci): added merge_group and added paths-ignore * chore(ci): updated description * chore(ci): set to Silverblue since we are testing Bluefin * chore(ci): Fixed secure boot key not found error Received error in anaconda when check was hit, need to set as a soft failure to exit the script early without stopping anaconda installation. * chore: fixed formatting * chore: fixed whitespace * chore(ci): Removed duplicate test * chore: fix whitespace * chore(ci): fixed test and removed upload to Github Artifacts * chore: updated README * feat: Re-enable Test Media Feature --- Makefile | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Makefile b/Makefile index 05dde54..636cbc1 100644 --- a/Makefile +++ b/Makefile @@ -37,6 +37,7 @@ $(IMAGE_NAME)-$(IMAGE_TAG).iso: output/$(IMAGE_NAME)-$(IMAGE_TAG).iso output/$(IMAGE_NAME)-$(IMAGE_TAG).iso: boot.iso container/$(IMAGE_NAME)-$(IMAGE_TAG) xorriso/input.txt mkdir $(_BASE_DIR)/output || true xorriso -dialog on < $(_BASE_DIR)/xorriso/input.txt + implantisomd5 $(_BASE_DIR)/output/$(IMAGE_NAME)-$(IMAGE_TAG).iso # Step 1: Generate Lorax Templates lorax_templates/%.tmpl: lorax_templates/%.tmpl.in @@ -60,10 +61,6 @@ boot.iso: lorax_templates/set_installer.tmpl lorax_templates/configure_upgrades. curl --fail -L -o $(_BASE_DIR)/sb_pubkey.der $(SECURE_BOOT_KEY_URL);\ fi - # Remove the "Test this media & install" menu entry - sed -i '/menuentry '\''Test this media & install @PRODUCT@ @VERSION@'\'' --class fedora --class gnu-linux --class gnu --class os {/,/}/d' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-bios.cfg - sed -i '/menuentry '\''Test this media & install @PRODUCT@ @VERSION@'\'' --class fedora --class gnu-linux --class gnu --class os {/,/}/d' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-efi.cfg - # Set the default menu entry to the first one sed -i 's/set default="1"/set default="0"/' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-bios.cfg sed -i 's/set default="1"/set default="0"/' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-efi.cfg @@ -72,6 +69,9 @@ boot.iso: lorax_templates/set_installer.tmpl lorax_templates/configure_upgrades. sed -i 's/linux @KERNELPATH@ @ROOT@ quiet/linux @KERNELPATH@ @ROOT@ quiet $(EXTRA_BOOT_PARAMS)/g' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-bios.cfg sed -i 's/linuxefi @KERNELPATH@ @ROOT@ quiet/linuxefi @KERNELPATH@ @ROOT@ quiet $(EXTRA_BOOT_PARAMS)/g' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-efi.cfg + sed -i 's/linux @KERNELPATH@ @ROOT@ rd.live.check quiet/linux @KERNELPATH@ @ROOT@ rd.live.check quiet $(EXTRA_BOOT_PARAMS)/g' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-bios.cfg + sed -i 's/linuxefi @KERNELPATH@ @ROOT@ rd.live.check quiet/linuxefi @KERNELPATH@ @ROOT@ rd.live.check quiet $(EXTRA_BOOT_PARAMS)/g' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-efi.cfg + sed -i 's/linux @KERNELPATH@ @ROOT@ nomodeset quiet/linux @KERNELPATH@ @ROOT@ nomodeset quiet $(EXTRA_BOOT_PARAMS)/g' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-bios.cfg sed -i 's/linuxefi @KERNELPATH@ @ROOT@ nomodeset quiet/linuxefi @KERNELPATH@ @ROOT@ nomodeset quiet $(EXTRA_BOOT_PARAMS)/g' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-efi.cfg