Sync docs

pull/314/head
David Finol 2022-01-02 01:39:12 -06:00
parent a3e783f430
commit cdb7cc65ab
4 changed files with 90 additions and 100 deletions

View File

@ -2,6 +2,10 @@ name: 'Unity - Builder'
author: Webber Takken <webber@takken.io>
description: 'Build Unity projects for different platforms.'
inputs:
targetPlatform:
required: true
default: ''
description: 'Platform that the build should target.'
unityVersion:
required: false
default: 'auto'
@ -10,10 +14,6 @@ inputs:
required: false
default: ''
description: 'Specific docker image that should be used for building the project'
targetPlatform:
required: false
default: ''
description: 'Platform that the build should target.'
projectPath:
required: false
default: ''
@ -30,38 +30,10 @@ inputs:
required: false
default: ''
description: 'Path to a Namespace.Class.StaticMethod to run to perform the build.'
remoteBuildCluster:
default: 'local'
customParameters:
required: false
description: 'Either local, k8s or aws can be used to run builds on a remote cluster. Additional parameters must be configured.'
awsStackName:
default: 'game-ci'
required: false
description: 'The Cloud Formation stack name that must be setup before using this option.'
kubeConfig:
default: ''
required: false
description: 'Supply a base64 encoded kubernetes config to run builds on kubernetes and stream logs until completion.'
kubeVolume:
default: ''
required: false
description: 'Supply a Persistent Volume Claim name to use for the Unity build.'
remoteBuildMemory:
default: '800M'
required: false
description: 'Amount of memory to assign the remote build container'
remoteBuildCpu:
default: '0.25'
required: false
description: 'Amount of CPU time to assign the remote build container'
kubeVolumeSize:
default: '5Gi'
required: false
description: 'Amount of disc space to assign the Kubernetes Persistent Volume'
githubToken:
default: ''
required: false
description: 'GitHub token for cloning, only needed when kubeconfig is used.'
description: 'Custom parameters to configure the build.'
versioning:
required: false
default: 'Semantic'
@ -102,14 +74,6 @@ inputs:
required: false
default: ''
description: 'The android target API level.'
customParameters:
required: false
default: ''
description: >
Custom parameters to configure the build.
Parameters must start with a hyphen (-) and may be followed by a value (without hyphen).
Parameters without a value will be considered booleans (with a value of true).
sshAgent:
required: false
default: ''
@ -117,8 +81,7 @@ inputs:
gitPrivateToken:
required: false
default: ''
description: >
Github private token to pull from github
description: 'Github private token to pull from github'
chownFilesTo:
required: false
default: ''
@ -126,12 +89,39 @@ inputs:
allowDirtyBuild:
required: false
default: ''
description: >
Allows the branch of the build to be dirty, and still generate the build.
Note that it is generally bad practice to modify your branch
in a CI Pipeline. However there are exceptions where this might
be needed. (use with care).
description: 'Allows the branch of the build to be dirty, and still generate the build.'
awsStackName:
default: 'game-ci'
required: false
description: 'The Cloud Formation stack name that must be setup before using this option.'
githubToken:
default: ''
required: false
description: 'GitHub token for cloning, only needed when kubeconfig is used.'
kubeConfig:
default: ''
required: false
description: 'Supply a base64 encoded kubernetes config to run builds on kubernetes and stream logs until completion.'
kubeVolume:
default: ''
required: false
description: 'Supply a Persistent Volume Claim name to use for the Unity build.'
kubeVolumeSize:
default: '5Gi'
required: false
description: 'Amount of disc space to assign the Kubernetes Persistent Volume'
remoteBuildCluster:
default: 'local'
required: false
description: 'Either local, k8s or aws can be used to run builds on a remote cluster. Additional parameters must be configured.'
remoteBuildCpu:
default: '0.25'
required: false
description: 'Amount of CPU time to assign the remote build container'
remoteBuildMemory:
default: '800M'
required: false
description: 'Amount of memory to assign the remote build container'
outputs:
volume:
description: 'The Persistent Volume (PV) where the build artifacts have been stored by Kubernetes'

44
dist/index.js vendored
View File

@ -624,15 +624,15 @@ const core = __webpack_require__(42186);
* Note that input is always passed as a string, even booleans.
*/
class Input {
static get targetPlatform() {
return core.getInput('targetPlatform') || platform_1.default.default;
}
static get unityVersion() {
return core.getInput('unityVersion') || 'auto';
}
static get customImage() {
return core.getInput('customImage');
}
static get targetPlatform() {
return core.getInput('targetPlatform') || platform_1.default.default;
}
static get projectPath() {
const rawProjectPath = core.getInput('projectPath') || '.';
return rawProjectPath.replace(/\/$/, '');
@ -646,6 +646,9 @@ class Input {
static get buildMethod() {
return core.getInput('buildMethod'); // processed in docker file
}
static get customParameters() {
return core.getInput('customParameters') || '';
}
static get versioningStrategy() {
return core.getInput('versioning') || 'Semantic';
}
@ -677,13 +680,6 @@ class Input {
static get androidTargetSdkVersion() {
return core.getInput('androidTargetSdkVersion') || '';
}
static get allowDirtyBuild() {
const input = core.getInput('allowDirtyBuild') || false;
return input === 'true';
}
static get customParameters() {
return core.getInput('customParameters') || '';
}
static get sshAgent() {
return core.getInput('sshAgent') || '';
}
@ -693,29 +689,33 @@ class Input {
static get chownFilesTo() {
return core.getInput('chownFilesTo') || '';
}
static get remoteBuildCluster() {
return core.getInput('remoteBuildCluster') || '';
static get allowDirtyBuild() {
const input = core.getInput('allowDirtyBuild') || false;
return input === 'true';
}
static get awsStackName() {
return core.getInput('awsStackName') || '';
}
static get kubeConfig() {
return core.getInput('kubeConfig') || '';
return core.getInput('awsStackName') || 'game-ci';
}
static get githubToken() {
return core.getInput('githubToken') || '';
}
static get remoteBuildMemory() {
return core.getInput('remoteBuildMemory') || '800M';
static get kubeConfig() {
return core.getInput('kubeConfig') || '';
}
static get remoteBuildCpu() {
return core.getInput('remoteBuildCpu') || '0.25';
static get kubeVolume() {
return core.getInput('kubeVolume') || '';
}
static get kubeVolumeSize() {
return core.getInput('kubeVolumeSize') || '5Gi';
}
static get kubeVolume() {
return core.getInput('kubeVolume') || '';
static get remoteBuildCluster() {
return core.getInput('remoteBuildCluster') || 'local';
}
static get remoteBuildCpu() {
return core.getInput('remoteBuildCpu') || '0.25';
}
static get remoteBuildMemory() {
return core.getInput('remoteBuildMemory') || '800M';
}
}
exports.default = Input;

2
dist/index.js.map vendored

File diff suppressed because one or more lines are too long

View File

@ -8,6 +8,10 @@ const core = require('@actions/core');
* Note that input is always passed as a string, even booleans.
*/
class Input {
static get targetPlatform() {
return core.getInput('targetPlatform') || Platform.default;
}
static get unityVersion() {
return core.getInput('unityVersion') || 'auto';
}
@ -16,10 +20,6 @@ class Input {
return core.getInput('customImage');
}
static get targetPlatform() {
return core.getInput('targetPlatform') || Platform.default;
}
static get projectPath() {
const rawProjectPath = core.getInput('projectPath') || '.';
return rawProjectPath.replace(/\/$/, '');
@ -37,6 +37,10 @@ class Input {
return core.getInput('buildMethod'); // processed in docker file
}
static get customParameters() {
return core.getInput('customParameters') || '';
}
static get versioningStrategy() {
return core.getInput('versioning') || 'Semantic';
}
@ -79,16 +83,6 @@ class Input {
return core.getInput('androidTargetSdkVersion') || '';
}
static get allowDirtyBuild() {
const input = core.getInput('allowDirtyBuild') || false;
return input === 'true';
}
static get customParameters() {
return core.getInput('customParameters') || '';
}
static get sshAgent() {
return core.getInput('sshAgent') || '';
}
@ -101,36 +95,42 @@ class Input {
return core.getInput('chownFilesTo') || '';
}
static get remoteBuildCluster() {
return core.getInput('remoteBuildCluster') || '';
static get allowDirtyBuild() {
const input = core.getInput('allowDirtyBuild') || false;
return input === 'true';
}
static get awsStackName() {
return core.getInput('awsStackName') || '';
}
static get kubeConfig() {
return core.getInput('kubeConfig') || '';
return core.getInput('awsStackName') || 'game-ci';
}
static get githubToken() {
return core.getInput('githubToken') || '';
}
static get remoteBuildMemory() {
return core.getInput('remoteBuildMemory') || '800M';
static get kubeConfig() {
return core.getInput('kubeConfig') || '';
}
static get remoteBuildCpu() {
return core.getInput('remoteBuildCpu') || '0.25';
static get kubeVolume() {
return core.getInput('kubeVolume') || '';
}
static get kubeVolumeSize() {
return core.getInput('kubeVolumeSize') || '5Gi';
}
static get kubeVolume() {
return core.getInput('kubeVolume') || '';
static get remoteBuildCluster() {
return core.getInput('remoteBuildCluster') || 'local';
}
static get remoteBuildCpu() {
return core.getInput('remoteBuildCpu') || '0.25';
}
static get remoteBuildMemory() {
return core.getInput('remoteBuildMemory') || '800M';
}
}