From 7286d00fbc4a8f34c3fa1391c8a641efcb7d8f5c Mon Sep 17 00:00:00 2001 From: Joseph Manley Date: Sat, 28 Dec 2019 16:56:53 -0500 Subject: [PATCH] Update README.md with refactor info --- ReadMe.md | 43 ++++++++++++++++++++++++++++--------------- 1 file changed, 28 insertions(+), 15 deletions(-) diff --git a/ReadMe.md b/ReadMe.md index 3270390..c4ee1a4 100644 --- a/ReadMe.md +++ b/ReadMe.md @@ -4,37 +4,50 @@ This action builds the godot project in your `$GITHUB_WORKSPACE`, so that you ca ## Usage -This action will create a `build` folder with subdirectories for linux, windows, and mac. You must have the export preset configured for each platform to successfully export. +This action will create a `build` folder an outputed build. You must have the export preset configured for the target platform to successfully export. Example: ```yaml steps: -- uses: josephbmanley/build-godot-action@master - env: - PROJECT: godot-project - SUBDIRECTORY: project +- uses: josephbmanley/build-godot-action@[VERSION] + with: + name: godot-project + preset: HTML5 ``` -### Environment Variables +### Inputs -- #### PROJECT **REQUIRED** +#### name **required** - Name of the project files to output. + The name of the exported package/binary - Eg. `godot-project` will export to `godot-project.exe` +#### preset **required** -- #### SUBDIRECTORY + The name of the preset found in `export_presets.cfg` you would like to build. - Subdirectory to export project into. +#### subdirectory - Eg. `project` will export to `$GITHUB_WORKSPACE/build/windows/project/godot-project.exe` + *Optional* -- #### PACKAGE + The subdirectory in the `build` folder to output build to, can be useful for self packaging. - Boolean value on whether or not to zip game files. Packages will be placed in the `$GITHUB_WORKSPACE/package` directory. +#### package + + *Optional* + + Boolean value, when set to true, builds artficat zip file. + +### Outputs + +#### build + + The location the outputed build is placed. + +#### artifact + + The location the outputed artifact is placed. - Default Value: `false` ## Credits