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
2019-11-29 23:57:53 -05:00

35 lines
917 B
Markdown

# Build Godot Project
This action builds the godot project in your `$GITHUB_WORKSPACE`, so that you can easily automate builds.
## 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.
Example:
```yaml
steps:
- uses: josephbmanley/build-godot-action@master
env:
PROJECT: godot-project
SUBDIRECTORY: project
```
### Environment Variables
- #### PROJECT **REQUIRED**
Name of the project files to output.
Eg. `godot-project` will export to `godot-project.exe`
- #### SUBDIRECTORY
Subdirectory to export project into.
Eg. `project` will export to `$GITHUB_WORKSPACE/build/windows/project/godot-project.exe`
## Credits
This action uses the [godot-ci](https://github.com/aBARICHELLO/godot-ci) docker image from [BARICHELLO](https://github.com/aBARICHELLO)