mirror of
https://github.com/JasonN3/build-container-installer.git
synced 2025-12-25 10:57:55 +01:00
fix: fixed up docs and alphabetized inputs
This commit is contained in:
Noel Miller
parent
90e5f6721b
commit
b7d07f098d
2 changed files with 40 additions and 36 deletions
31
README.md
31
README.md
|
|
@ -34,27 +34,28 @@ See [Customizing](#customizing) for information about customizing the ISO that g
|
|||
The following variables can be used to customize the created ISO.
|
||||
|
||||
### Inputs
|
||||
| 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 | quay.io/fedora-ostree-desktops |
|
||||
| IMAGE_NAME | Name of the source container image | base |
|
||||
| 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\* | Server |
|
||||
| WEB_UI | Enable Anaconda WebUI (experimental) | false |
|
||||
| ISO_NAME | Name of the ISO you wish to output when completed | IMAGE_NAME-IMAGE_TAG |
|
||||
| Variable | Description | Default Value |
|
||||
| -------------------- | ---------------------------------------------------------------------------- | ------------------------------ |
|
||||
| additional_templates | Space delimited list of additional Lorax templates to include | \[empty\] |
|
||||
| arch | Architecture for image to build | x86_64 |
|
||||
| enrollment_password | Used for supporting secure boot (requires SECURE_BOOT_KEY_URL to be defined) | container-installer |
|
||||
| extra_boot_params | Extra params used by grub to boot the anaconda installer | \[empty\] |
|
||||
| image_name | Name of the source container image | base |
|
||||
| image_repo | Repository containing the source container image | quay.io/fedora-ostree-desktops |
|
||||
| image_tag | Tag of the source container image | *VERSION* |
|
||||
| iso_name | Name of the ISO you wish to output when completed | build/deploy.iso |
|
||||
| secure_boot_key_url | Secure boot key that is installed from URL location | \[empty\] |
|
||||
| variant | Source container variant\* | Server |
|
||||
| version | Fedora version of installer to build | 39 |
|
||||
| web_ui | Enable Anaconda WebUI (experimental) | false |
|
||||
|
||||
Available options for VARIANT can be found by running `dnf provides system-release`.
|
||||
\*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 |
|
||||
| ----------------- | ------------------------------------------------------ | -------------------------------------------------------- |
|
||||
| output-directory | Path to all files in the output directory | ${{ steps.YOUR_ID_FOR_ACTION.outputs.output-directory }} |
|
||||
| iso-path | Path to just the ISO file that the action creates | ${{ steps.YOUR_ID_FOR_ACTION.outputs.iso-path }} |
|
||||
| checksum-path | Path to just the checksum file that the action creates | ${{ steps.YOUR_ID_FOR_ACTION.outputs.checksum-path }} |
|
||||
| iso_name | Path to just the ISO file that the action creates | ${{ steps.YOUR_ID_FOR_ACTION.outputs.iso_name }} |
|
||||
|
||||
For outputs, see example above.
|
||||
|
||||
|
|
|
|||
45
action.yml
45
action.yml
|
|
@ -2,10 +2,24 @@ name: Build Container Installer
|
|||
description: Generates an ISO for installing an OSTree stored in a container image
|
||||
|
||||
inputs:
|
||||
action_version:
|
||||
description: Version of the action container to run
|
||||
deprecationMessage: No longer used. github.action_ref replaces the need for this. Will be removed in a future version.
|
||||
required: false
|
||||
additional_templates:
|
||||
description: Space delimited list of additional Lorax templates to include
|
||||
required: false
|
||||
arch:
|
||||
description: Architecture for image to build
|
||||
required: true
|
||||
default: x86_64
|
||||
enrollment_password:
|
||||
description: Used for supporting secure boot (requires SECURE_BOOT_KEY_URL to be defined)
|
||||
required: false
|
||||
default: "container-installer"
|
||||
extra_boot_params:
|
||||
description: Extra params used by grub to boot the anaconda installer
|
||||
required: false
|
||||
image_name:
|
||||
description: Name of the source container image
|
||||
required: true
|
||||
|
|
@ -14,6 +28,16 @@ inputs:
|
|||
description: Repository containing the source container image
|
||||
required: true
|
||||
default: quay.io/fedora-ostree-desktops
|
||||
image_tag:
|
||||
description: Tag of the source container image. Defaults to the installer version
|
||||
required: false
|
||||
iso_name:
|
||||
description: "Name of the resulting ISO. Relative paths are relative to github.workspace"
|
||||
required: false
|
||||
default: build/deploy.iso
|
||||
secure_boot_key_url:
|
||||
description: Secure boot key that is installed from URL location
|
||||
required: false
|
||||
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
|
||||
|
|
@ -22,31 +46,10 @@ inputs:
|
|||
description: Fedora version of installer to build
|
||||
required: true
|
||||
default: "39"
|
||||
image_tag:
|
||||
description: Tag of the source container image. Defaults to the installer version
|
||||
required: false
|
||||
web_ui:
|
||||
description: Enable Anaconda WebUI
|
||||
required: false
|
||||
default: "false"
|
||||
iso_name:
|
||||
description: "Name of the resulting ISO. Relative paths are relative to github.workspace"
|
||||
required: false
|
||||
default: build/deploy.iso
|
||||
enrollment_password:
|
||||
description: Used for supporting secure boot (requires SECURE_BOOT_KEY_URL to be defined)
|
||||
required: false
|
||||
default: "container-installer"
|
||||
secure_boot_key_url:
|
||||
description: Secure boot key that is installed from URL location
|
||||
required: false
|
||||
action_version:
|
||||
description: Version of the action container to run
|
||||
deprecationMessage: No longer used. github.action_ref replaces the need for this. Will be removed in a future version.
|
||||
required: false
|
||||
additional_templates:
|
||||
description: Space delimited list of additional Lorax templates to include
|
||||
required: false
|
||||
|
||||
outputs:
|
||||
iso_name:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue