Actions/setup-godot
1
Fork 0
mirror of https://github.com/chickensoft-games/setup-godot.git synced 2025-08-15 05:15:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update readme

Browse Source
This commit is contained in:
Joanna May 2023-03-14 19:00:11 -05:00
parent 02a9640ccf
commit a5592a5899
2 changed files with 15 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/test.yml vendored
View File

@ -8,7 +8,7 @@ on: # rebuild any PRs and main branch changes
jobs: jobs:
tests: tests:
name: 🧪 Test on ${{ matrix.os }} name: 🧪 Test on ${{ matrix.os }}, .NET=${{ matrix.use-dotnet }}
runs-on: ${{ matrix.os }} runs-on: ${{ matrix.os }}
strategy: strategy:
# Don't cancel other OS runners if one fails. # Don't cancel other OS runners if one fails.

21
README.md
View File

@ -1,11 +1,12 @@
# Setup Godot # 🤖 Setup Godot
[![Chickensoft Badge][chickensoft-badge]][chickensoft-website] [![Discord][discord-badge]][discord] [![Chickensoft Badge][chickensoft-badge]][chickensoft-website] [![Discord][discord-badge]][discord] [![Read the docs][read-the-docs-badge]][docs]
Setup Godot for use with .NET on macOS, Windows, and Linux CI/CD runners. Setup Godot for use with (or without) .NET on macOS, Windows, and Linux CI/CD runners.
- ✅ Godot 4.x - ✅ Godot 4.x
- ✅ C# supported using .NET version of Godot. - ✅ C# supported using .NET version of Godot.
- ✅ Versions **without** .NET are also supported.
- ✅ Installs Godot directly on the CI/CD runner. - ✅ Installs Godot directly on the CI/CD runner.
- ✅ Caches Godot installation for speedier workflows. - ✅ Caches Godot installation for speedier workflows.
- ✅ Adds environment variables (`GODOT4`, `GODOT`) to the system path. - ✅ Adds environment variables (`GODOT4`, `GODOT`) to the system path.
@ -59,6 +60,8 @@ jobs:
# Version must include major, minor, and patch, and be >= 4.0.0 # Version must include major, minor, and patch, and be >= 4.0.0
# Pre-release label is optional. # Pre-release label is optional.
version: 4.0.0-beta16 # also valid: 4.0.0.rc1 or 4.0.0, etc version: 4.0.0-beta16 # also valid: 4.0.0.rc1 or 4.0.0, etc
# Use .NET-enabled version of Godot (the default is also true).
use-dotnet: true
- name: 🔬 Verify Setup - name: 🔬 Verify Setup
run: | run: |
@ -74,10 +77,14 @@ jobs:
# Do whatever you want! # Do whatever you want!
``` ```
<!-- Links --> ## Inputs
<!-- Header --> See [action.yml][action] for information about the action's inputs.
[chickensoft-badge]: https://chickensoft.games/images/chickensoft/chickensoft_badge.svg
[chickensoft-badge]: https://raw.githubusercontent.com/chickensoft-games/chickensoft_site/main/static/img/badges/chickensoft_badge.svg
[chickensoft-website]: https://chickensoft.games [chickensoft-website]: https://chickensoft.games
[discord-badge]: https://raw.githubusercontent.com/chickensoft-games/chickensoft_site/main/static/img/badges/discord_badge.svg
[discord]: https://discord.gg/gSjaPgMmYW [discord]: https://discord.gg/gSjaPgMmYW
[discord-badge]: https://img.shields.io/badge/Chickensoft%20Discord-%237289DA.svg?style=flat&logo=discord&logoColor=white [read-the-docs-badge]: https://raw.githubusercontent.com/chickensoft-games/chickensoft_site/main/static/img/badges/read_the_docs_badge.svg
[docs]: https://chickensoft.games/docs
[action]: ./action.yml