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

29 lines
734 B
Markdown
Raw Normal View History

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-11-30 01:34:21 +02:00
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.
2019-11-30 01:32:35 +02:00
Example:
```yaml
steps:
- uses: josephbmanley/build-godot-action@v1.0.0
2019-11-30 01:32:35 +02:00
env:
PROJECT: godot-project
```
### Environment Variables
- #### PROJECT **REQUIRED**
Name of the project files to output.
Eg. `godot-project` will export to `godot-project.exe`
## Credits
This action uses the [godot-ci](https://github.com/aBARICHELLO/godot-ci) docker image from [BARICHELLO](https://github.com/aBARICHELLO)