This repository has been archived on 2024-11-15. You can view files and clone it, but cannot push or open issues or pull requests.
build-godot-action/ReadMe.md

57 lines
1.2 KiB
Markdown
Raw Normal View History

2020-02-01 07:05:56 +02:00
![Test Action](https://github.com/josephbmanley/build-godot-action/workflows/Test%20Action/badge.svg)
2019-11-30 06:34:12 +02:00
# Build Godot Project
2019-11-30 01:32:35 +02:00
This action builds the godot project in your `$GITHUB_WORKSPACE`, so that you can easily automate builds.
## Usage
2019-12-28 23:56:53 +02:00
This action will create a `build` folder an outputed build. You must have the export preset configured for the target platform to successfully export.
2019-11-30 01:34:21 +02:00
2019-11-30 01:32:35 +02:00
Example:
```yaml
steps:
2019-12-28 23:56:53 +02:00
- uses: josephbmanley/build-godot-action@[VERSION]
with:
name: godot-project
preset: HTML5
2019-11-30 01:32:35 +02:00
```
2019-12-28 23:56:53 +02:00
### Inputs
2019-11-30 01:32:35 +02:00
2019-12-28 23:56:53 +02:00
#### name **required**
2019-11-30 01:32:35 +02:00
2019-12-28 23:56:53 +02:00
The name of the exported package/binary
2019-11-30 01:32:35 +02:00
2019-12-28 23:56:53 +02:00
#### preset **required**
2019-11-30 01:32:35 +02:00
2019-12-28 23:56:53 +02:00
The name of the preset found in `export_presets.cfg` you would like to build.
2019-11-30 06:55:42 +02:00
2019-12-28 23:56:53 +02:00
#### subdirectory
2019-11-30 06:55:42 +02:00
2019-12-28 23:56:53 +02:00
*Optional*
2019-11-30 06:55:42 +02:00
2019-12-28 23:56:53 +02:00
The subdirectory in the `build` folder to output build to, can be useful for self packaging.
2019-12-28 23:56:53 +02:00
#### 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.
2019-11-30 01:32:35 +02:00
## Credits
This action uses the [godot-ci](https://github.com/aBARICHELLO/godot-ci) docker image from [BARICHELLO](https://github.com/aBARICHELLO)