[CloudRunner] actions yaml descriptions

pull/437/head
Frostebite 2022-10-22 23:31:39 +01:00
parent b003e40b29
commit 8fa45121ef
1 changed files with 21 additions and 15 deletions

View File

@ -96,25 +96,26 @@ inputs:
required: false required: false
default: '' default: ''
description: description:
'[CloudRunner] run a post build job in yaml format with the keys image, secrets (name, value object array), command string' '[CloudRunner] run a post build job in yaml format with the keys image, secrets (name, value object array),
command string'
preBuildSteps: preBuildSteps:
required: false required: false
default: '' default: ''
description: description:
'[CloudRunner] Run a pre build job after the repository setup but before the build job (in yaml format with the keys image, '[CloudRunner] Run a pre build job after the repository setup but before the build job (in yaml format with the
secrets (name, value object array), command line string)' keys image, secrets (name, value object array), command line string)'
customStepFiles: customStepFiles:
required: false required: false
default: '' default: ''
description: description:
'[CloudRunner] Specify the names (by file name) of custom steps to run before or after cloud runner jobs, must match a yaml step '[CloudRunner] Specify the names (by file name) of custom steps to run before or after cloud runner jobs, must
file inside your repo in the folder .game-ci/steps/' match a yaml step file inside your repo in the folder .game-ci/steps/'
customHookFiles: customHookFiles:
required: false required: false
default: '' default: ''
description: description:
'[CloudRunner] Specify the names (by file name) of custom hooks to run before or after cloud runner jobs, must match a yaml step '[CloudRunner] Specify the names (by file name) of custom hooks to run before or after cloud runner jobs, must
file inside your repo in the folder .game-ci/hooks/' match a yaml step file inside your repo in the folder .game-ci/hooks/'
customJobHooks: customJobHooks:
required: false required: false
default: '' default: ''
@ -123,8 +124,8 @@ inputs:
required: false required: false
default: '' default: ''
description: description:
'[CloudRunner] Run a custom job instead of the standard build automation for cloud runner (in yaml format with the keys image, '[CloudRunner] Run a custom job instead of the standard build automation for cloud runner (in yaml format with the
secrets (name, value object array), command line string)' keys image, secrets (name, value object array), command line string)'
awsBaseStackName: awsBaseStackName:
default: 'game-ci' default: 'game-ci'
required: false required: false
@ -133,7 +134,8 @@ inputs:
default: 'local' default: 'local'
required: false required: false
description: description:
'[CloudRunner] Either local, k8s or aws can be used to run builds on a remote cluster. Additional parameters must be configured.' '[CloudRunner] Either local, k8s or aws can be used to run builds on a remote cluster. Additional parameters must
be configured.'
cloudRunnerCpu: cloudRunnerCpu:
default: '' default: ''
required: false required: false
@ -150,13 +152,14 @@ inputs:
default: '' default: ''
required: false required: false
description: description:
'[CloudRunner] Extend game ci by specifying a command to execute to pull input from external source e.g cloud provider secret '[CloudRunner] Extend game ci by specifying a command to execute to pull input from external source e.g cloud
managers' provider secret managers'
kubeConfig: kubeConfig:
default: '' default: ''
required: false required: false
description: description:
'[CloudRunner] Supply a base64 encoded kubernetes config to run builds on kubernetes and stream logs until completion.' '[CloudRunner] Supply a base64 encoded kubernetes config to run builds on kubernetes and stream logs until
completion.'
kubeVolume: kubeVolume:
default: '' default: ''
required: false required: false
@ -164,7 +167,8 @@ inputs:
kubeStorageClass: kubeStorageClass:
default: '' default: ''
required: false required: false
description: '[CloudRunner] Kubernetes storage class to use for cloud runner jobs, leave empty to install rook cluster.' description:
'[CloudRunner] Kubernetes storage class to use for cloud runner jobs, leave empty to install rook cluster.'
kubeVolumeSize: kubeVolumeSize:
default: '5Gi' default: '5Gi'
required: false required: false
@ -176,7 +180,9 @@ inputs:
watchToEnd: watchToEnd:
default: 'true' default: 'true'
required: false required: false
description: '[CloudRunner] Whether or not to watch the build to the end. Can be used for especially long running jobs e.g imports or self-hosted ephemeral runners.' description:
'[CloudRunner] Whether or not to watch the build to the end. Can be used for especially long running jobs e.g
imports or self-hosted ephemeral runners.'
outputs: outputs:
volume: volume:
description: 'The Persistent Volume (PV) where the build artifacts have been stored by Kubernetes' description: 'The Persistent Volume (PV) where the build artifacts have been stored by Kubernetes'