Fix Container Copying to Directory

.github/workflows/build-and-test.yml

@@ -18,7 +18,6 @@ env:
   SECURE_BOOT_KEY_URL: 'https://github.com/ublue-os/akmods/raw/main/certs/public_key.der'
   ENROLLMENT_PASSWORD: 'container-installer'
 
-
 jobs:
   build-container:
     runs-on: ubuntu-latest
@@ -47,7 +46,7 @@ jobs:
         with:
           containerfiles: Containerfile
           tags: ${{ steps.meta.outputs.tags }}
-          
+
       - name: Push image
         uses: redhat-actions/push-to-registry@v2
         with:
@@ -56,7 +55,6 @@ jobs:
           username: ${{ github.actor }}
           password: ${{ github.token }}
 
-
   build-and-push-iso:
     runs-on: ubuntu-latest
     needs:
@@ -65,6 +63,10 @@ jobs:
       contents: read
       packages: write
     steps:
+      - name: Set Environment Variables
+        run: |
+          echo "ISO_NAME=${{ env.IMAGE_NAME }}-${{ env.VERSION }}" >> $GITHUB_ENV
+
       - name: Checkout repo
         uses: actions/checkout@v4
 
@@ -84,6 +86,7 @@ jobs:
 
       - name: Build ISO with new container
         uses: ./
+        id: build
         with:
           arch: ${{ env.ARCH}}
           image_name: ${{ env.IMAGE_NAME}}
@@ -92,17 +95,16 @@ jobs:
           variant: ${{ env.VARIANT }}
           secure_boot_key_url: ${{ env.SECURE_BOOT_KEY_URL }}
           enrollment_password: ${{ env.ENROLLMENT_PASSWORD }}
-
-      - name: Rename ISO
-        run: |
-          mv build/deploy.iso build/${{ env.IMAGE_NAME }}-${{ env.VERSION }}.iso
+          iso_name: ${{ env.ISO_NAME }}
 
       - name: Upload ISO as artifact
         id: upload
         uses: actions/upload-artifact@v4
         with:
-          name: ${{ env.IMAGE_NAME }}-${{ env.VERSION }}.iso
-          path: build/*.iso
+          name: ${{ env.ISO_NAME }}.iso
+          path: | 
+            ${{ steps.build.outputs.iso-path }}
+            ${{ steps.build.outputs.checksum-path }}
           if-no-files-found: error
           retention-days: 0
           compression-level: 0

Containerfile

@@ -11,6 +11,7 @@ ENV VERSION="${VERSION}"
 ENV WEB_UI="false"
 
 RUN mkdir /build-container-installer
+
 COPY / /build-container-installer/
 
 WORKDIR /build-container-installer

Makefile

@@ -12,6 +12,7 @@ ENROLLMENT_PASSWORD =
 SECURE_BOOT_KEY_URL =
 ADDITIONAL_TEMPLATES = 
 ROOTFS_SIZE = 4
+ISO_NAME = $(IMAGE_NAME)-$(IMAGE_TAG)
 
 # Generated vars
 ## Formatting = _UPPERCASE
@@ -33,12 +34,14 @@ ifeq ($(WEB_UI),true)
 _LORAX_ARGS += -i anaconda-webui
 endif
 
-# Step 7: Buid end ISO
+# Step 7: Build end ISO
 ## Default action
 build/deploy.iso:  boot.iso container/$(IMAGE_NAME)-$(IMAGE_TAG) xorriso/input.txt
 	mkdir $(_BASE_DIR)/build || true
 	xorriso -dialog on < $(_BASE_DIR)/xorriso/input.txt
 	implantisomd5 build/deploy.iso
+	mv build/deploy.iso build/$(ISO_NAME).iso
+	cd build && sha256sum $(ISO_NAME).iso > $(ISO_NAME)-CHECKSUM
 
 # Step 1: Generate Lorax Templates
 lorax_templates/post_%.tmpl: lorax_templates/scripts/post/%
@@ -174,7 +177,7 @@ clean:
 	rm -f $(_BASE_DIR)/*.log || true
 
 install-deps:
-	dnf install -y lorax xorriso skopeo
+	dnf install -y lorax xorriso skopeo coreutils
 
 test-iso:
 	$(eval _TESTS = $(filter-out README.md,$(shell ls tests/iso)))

README.md

@@ -8,19 +8,34 @@ This action is designed to be called from a GitHub workflow using the following
 ```yaml
 - name: Build ISO
   uses: jasonn3/build-container-installer/v1.0.0
+  id: build
   with:
     arch: ${{ env.ARCH}}
     image_name: ${{ env.IMAGE_NAME}}
     image_repo: ${{ env.IMAGE_REPO}}
     version: ${{ env.VERSION }}
     variant: ${{ env.VARIANT }}
+
+# This example is for uploading your ISO as a Github artifact. You can do something similar using any cloud storage, so long as you copy the output
+- name: Upload ISO as artifact
+  id: upload
+  uses: actions/upload-artifact@v4
+  with:
+    name: my_iso.iso
+    path: |
+      ${{ steps.build.outputs.iso_path }}
+      ${{ steps.build.outputs.checksum-path }}
+  if-no-files-found: error
+  retention-days: 0
+  compression-level: 0
 ```
 
 See [Customizing](#customizing) for information about customizing the ISO that gets created using `with`
 
 ## Customizing
 The following variables can be used to customize the created ISO.
 
+### Inputs
 | Variable          | Description                                              | Default Value                  |
 | ----------------- | -------------------------------------------------------- | ------------------------------ |
 | ARCH              | Architecture for image to build                          | x86_64                         |
@@ -31,10 +46,19 @@ The following variables can be used to customize the created ISO.
 | EXTRA_BOOT_PARAMS | Extra params used by grub to boot the anaconda installer | \[empty\]                      |
 | VARIANT           | Source container variant\*                               | Server                         |
 | WEB_UI            | Enable Anaconda WebUI (experimental)                     | false                          |
+| ISO_NAME          | Name of the ISO you wish to output when completed        | IMAGE_NAME-IMAGE_TAG           |
 
 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
 
+### Outputs
+| Variable          | Description                                              | Usage                                            |
+| ----------------- | -------------------------------------------------------- | ------------------------------------------------ |
+| iso-path          | Path to ISO file that the action creates                 | ${{ steps.YOUR_ID_FOR_ACTION.outputs.iso_path }} |
+| checksum-path     | Path to the checksum file that the action creates        | ${{ steps.YOUR_ID_FOR_ACTION.outputs.iso_path }} |
+
+For outputs, see example above.
+
 ## Development
 ### Makefile
 The Makefile contains all of the commands that are run in the action. There are separate targets for each file generated, however `make` can be used to generate the final image and `make clean` can be used to clean up the workspace. The resulting ISO will be stored in the `build` directory.
@@ -55,12 +79,12 @@ Examples:
 
 Building an ISO to install Fedora 38
 ```bash
-docker run --rm --privileged --volume .:/build-container-installer/build -e VERSION=38 -e IMAGE_NAME=base -e IMAGE_TAG=38 -e VARIANT=Server ghcr.io/jasonn3/build-container-installer:latest
+docker run --rm --privileged --volume .:/build-container-installer/build  ghcr.io/jasonn3/build-container-installer:latest VERSION=38 IMAGE_NAME=base IMAGE_TAG=38 VARIANT=Server
 ```
 
 Building an ISO to install Fedora 39
 ```bash
-docker run --rm --privileged --volume .:/build-container-installer/build -e VERSION=39 -e IMAGE_NAME=base -e IMAGE_TAG=39 -e VARIANT=Server ghcr.io/jasonn3/build-container-installer:latest
+docker run --rm --privileged --volume .:/build-container-installer/build  ghcr.io/jasonn3/build-container-installer:latest VERSION=39 IMAGE_NAME=base IMAGE_TAG=39 VARIANT=Server
 ```
 
 ### VSCode Dev Container

action.yml

@@ -29,6 +29,9 @@ inputs:
     description: Enable Anaconda WebUI
     required: false
     default: "false"
+  iso_name:
+    description: Used for specifying the name of the output iso
+    required: false
   enrollment_password:
     description: Used for supporting secure boot (requires SECURE_BOOT_KEY_URL to be defined)
     required: false
@@ -44,24 +47,36 @@ inputs:
     description: Space delimetered list of additional Lorax templates to include
     required: false
 
+outputs:
+  iso-path:
+    value: ${{ steps.run_docker.outputs.ISO_PATH }}
+    description: The location of the .iso object
+  checksum-path:
+    value: ${{ steps.run_docker.outputs.CHECKSUM_PATH }}
+    description: The location of the checksum
+
 runs:
   using: composite
   steps:
     - name: Run docker image
+      id: run_docker
       shell: bash
       run: |
         # Check if running inside of the action repo
         if [[ -z "${{ github.action_ref }}" ]]; then if [[ "${{ github.ref_name }}" =~ (.*)/merge ]]; then tag=pr-${BASH_REMATCH[1]}; else tag=${{ github.ref_name }}; fi; fi
         if [[ -z "${tag}" ]]; then tag=${{ github.action_ref }}; fi
-        docker run --privileged --volume ${{ github.workspace }}:/github/workspace/ ghcr.io/jasonn3/build-container-installer:${tag} \
+        docker run --privileged --volume ${{ github.workspace }}:/build-container-installer/build ghcr.io/jasonn3/build-container-installer:${tag} \
           ARCH=${{ inputs.arch }} \
           IMAGE_NAME=${{ inputs.image_name }} \
           IMAGE_REPO=${{ inputs.image_repo }} \
           VARIANT=${{ inputs.variant }} \
           VERSION=${{ inputs.version }} \
           IMAGE_TAG=${{ inputs.image_tag || inputs.version }} \
           WEB_UI=${{ inputs.web_ui }} \
+          ISO_NAME=${{ inputs.iso_name }} \
           ENROLLMENT_PASSWORD=${{ inputs.enrollment_password }} \
           SECURE_BOOT_KEY_URL=${{ inputs.secure_boot_key_url }} \
           "ADDITIONAL_TEMPLATES=${{ inputs.additional_templates }}"
+        echo "ISO_PATH=$(realpath ${{ github.workspace }}/${{ inputs.iso_name }}.iso)" >> $GITHUB_OUTPUT
+        echo "CHECKSUM_PATH=$(realpath ${{ github.workspace }}/${{ inputs.iso_name }}-CHECKSUM)" >> $GITHUB_OUTPUT
 

entrypoint.sh

@@ -2,9 +2,8 @@
 
 set -ex
 
-for entry in $@
-do
-  export $entry
+for entry in $@; do
+	export $entry
 done
 
 # Pull container
@@ -15,11 +14,3 @@ make boot.iso $@
 
 # Add container to ISO
 make build/deploy.iso $@
-
-# Make output dir in github workspace
-mkdir /github/workspace/build || true
-
-# Copy resulting iso to github workspace and fix permissions
-cp build/deploy.iso /github/workspace/build
-chmod -R ugo=rwX /github/workspace/build
-