[CloudRunner] actions yaml descriptions

pull/437/head
Frostebite 2022-10-22 23:30:36 +01:00
parent a3a11dab58
commit b003e40b29
1 changed files with 20 additions and 20 deletions

View File

@ -82,7 +82,7 @@ inputs:
gitPrivateToken: gitPrivateToken:
required: false required: false
default: '' default: ''
description: 'Github private token to pull from github' description: '[CloudRunner] Github private token to pull from github'
chownFilesTo: chownFilesTo:
required: false required: false
default: '' default: ''
@ -91,92 +91,92 @@ inputs:
allowDirtyBuild: allowDirtyBuild:
required: false required: false
default: '' default: ''
description: 'Allows the branch of the build to be dirty, and still generate the build.' description: '[CloudRunner] Allows the branch of the build to be dirty, and still generate the build.'
postBuildSteps: postBuildSteps:
required: false required: false
default: '' default: ''
description: description:
'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:
'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 keys image,
secrets (name, value object array), command line string)' secrets (name, value object array), command line string)'
customStepFiles: customStepFiles:
required: false required: false
default: '' default: ''
description: description:
'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 match a yaml step
file inside your repo in the folder .game-ci/steps/' file inside your repo in the folder .game-ci/steps/'
customHookFiles: customHookFiles:
required: false required: false
default: '' default: ''
description: description:
'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 match a yaml step
file inside your repo in the folder .game-ci/hooks/' file inside your repo in the folder .game-ci/hooks/'
customJobHooks: customJobHooks:
required: false required: false
default: '' default: ''
description: 'Specify custom commands and trigger hooks (injects commands into jobs)' description: '[CloudRunner] Specify custom commands and trigger hooks (injects commands into jobs)'
customJob: customJob:
required: false required: false
default: '' default: ''
description: description:
'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 keys image,
secrets (name, value object array), command line string)' secrets (name, value object array), command line string)'
awsBaseStackName: awsBaseStackName:
default: 'game-ci' default: 'game-ci'
required: false required: false
description: 'The Cloud Formation stack name that must be setup before using this option.' description: '[CloudRunner] The Cloud Formation stack name that must be setup before using this option.'
cloudRunnerCluster: cloudRunnerCluster:
default: 'local' default: 'local'
required: false required: false
description: description:
'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
description: 'Amount of CPU time to assign the remote build container' description: '[CloudRunner] Amount of CPU time to assign the remote build container'
cloudRunnerMemory: cloudRunnerMemory:
default: '' default: ''
required: false required: false
description: 'Amount of memory to assign the remote build container' description: '[CloudRunner] Amount of memory to assign the remote build container'
readInputFromOverrideList: readInputFromOverrideList:
default: '' default: ''
required: false required: false
description: 'Comma separated list of input value names to read from "input override command"' description: '[CloudRunner] Comma separated list of input value names to read from "input override command"'
readInputOverrideCommand: readInputOverrideCommand:
default: '' default: ''
required: false required: false
description: description:
'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 provider secret
managers' managers'
kubeConfig: kubeConfig:
default: '' default: ''
required: false required: false
description: description:
'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
description: 'Supply a Persistent Volume Claim name to use for the Unity build.' description: '[CloudRunner] Supply a Persistent Volume Claim name to use for the Unity build.'
kubeStorageClass: kubeStorageClass:
default: '' default: ''
required: false required: false
description: '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
description: 'Amount of disc space to assign the Kubernetes Persistent Volume' description: '[CloudRunner] Amount of disc space to assign the Kubernetes Persistent Volume'
cacheKey: cacheKey:
default: '' default: ''
required: false required: false
description: 'Cache key to indicate bucket for cache' description: '[CloudRunner] Cache key to indicate bucket for cache'
watchToEnd: watchToEnd:
default: 'true' default: 'true'
required: false required: false
description: 'Watch build to end or leave unattended: true/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.'
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'