diff --git a/README.md b/ReadMe.md similarity index 86% rename from README.md rename to ReadMe.md index d91f808..d6f6f6f 100644 --- a/README.md +++ b/ReadMe.md @@ -1,13 +1,13 @@ -![Release Version](https://img.shields.io/github/v/release/felix-schindler/build-godot-action) +![Release Version](https://img.shields.io/github/v/release/josephbmanley/build-godot-action) ![Test Action](https://github.com/josephbmanley/build-godot-action/workflows/Test%20Action/badge.svg) ![Build Godot Project](logo.png) This action builds the godot project in your `$GITHUB_WORKSPACE`, so that you can easily automate builds. Table of Contents: - -- [Quickstart](#quickstart) -- [Usage](#usage) +- [Quickstart](#Quickstart) +- [Usage](#Usage) +- [Contributors](Contributors.md) ## Quickstart @@ -42,7 +42,7 @@ jobs: lfs: true - name: Build id: build - uses: felix-schindler/build-godot-action@v2.0.0 + uses: manleydev/build-godot-action@v1.4.1 with: name: example preset: ${{ matrix.platform }} @@ -60,7 +60,6 @@ This workflow has three steps: - **Checkout**: The Checkout step clones the project on the GitHub actions runner. - **Build**: This step uses this action to build the Godot project. - **Upload Artifact**: The Upload Artifact step uploads the output from the build step. - > You could also use something like [softprops/action-gh-release](https://github.com/softprops/action-gh-release) to create automated releases of your game, instead of just uploading it as a artifact. **Matrix Explaination**: The matrix object runs the job for EACH possible value. So in this job, we are using a `platform` matrix to automatically run our workflow for the values `linux`, `windows`, and `mac`. @@ -83,7 +82,7 @@ Additionally if you are not using a matrix, you can set the export preset as the ```yaml - name: Build id: build - uses: felix-schindler/build-godot-action@v2.0.0 + uses: manleydev/build-godot-action@v1.4.1 with: name: example preset: win32 @@ -96,7 +95,7 @@ To change the export name, you can the `name` parameter to whatever you want you ```yaml - name: Build id: build - uses: felix-schindler/build-godot-action@v2.0.0 + uses: manleydev/build-godot-action@v1.4.1 with: name: test # This project will export with the name "test" ``` @@ -108,7 +107,7 @@ This example is set to build with debug mode enable. To disable debug, either se ```yaml - name: Build id: build - uses: felix-schindler/build-godot-action@v2.0.0 + uses: manleydev/build-godot-action@v1.4.1 with: name: example preset: ${{ matrix.platform }} @@ -122,7 +121,7 @@ If your project is located in a subdirectory, you can use the `projectDir` to ch ```yaml - name: Build id: build - uses: felix-schindler/build-godot-action@v2.0.0 + uses: manleydev/build-godot-action@v1.4.1 with: name: example preset: ${{ matrix.platform }} @@ -143,7 +142,7 @@ Example: ```yaml steps: -- uses: felix-schindler/build-godot-action@[VERSION] +- uses: manleydev/build-godot-action@[VERSION] with: name: godot-project preset: HTML5 @@ -159,6 +158,12 @@ steps: The name of the preset found in `export_presets.cfg` you would like to build. +#### subdirectory + + *Optional* + + The subdirectory in the `build` folder to output build to, can be useful for self packaging. + #### package *Optional* diff --git a/action.yml b/action.yml index 043b96e..51d3ed0 100644 --- a/action.yml +++ b/action.yml @@ -1,4 +1,4 @@ -name: "Build Godot Games" +name: "Build Godot" description: "Build a Godot project for multiple platforms" author: josephbmanley inputs: @@ -9,7 +9,7 @@ inputs: description: 'Name of the preset in `export_presets.cfg` to use' required: true subdirectory: - description: 'This has been removed, please do not use.' + description: 'Optional name of the subdirectory to put exported project in' default: "" package: description: 'Set true to output an artifact zip file' diff --git a/entrypoint.sh b/entrypoint.sh index 62ee593..04e6f3f 100644 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -3,8 +3,7 @@ set -e # Move godot templates already installed from the docker image to home mkdir -v -p ~/.local/share/godot/export_templates -mkdir ./Builds -# cp -a -f /root/.local/share/godot/export_templates/. ~/.local/share/godot/export_templates/ +cp -a /root/.local/share/godot/export_templates/. ~/.local/share/godot/export_templates/ if [ "$3" != "" ] @@ -26,8 +25,6 @@ cd "$GITHUB_WORKSPACE/$5" godot ./project.godot --headless --${mode} "$2" echo "Build Done" -ls -la ./Builds - if [ "$5" != "" ] then BUILD_PATH="$GITHUB_WORKSPACE/$5/build/" @@ -41,7 +38,7 @@ if [ "$4" = "true" ] then echo "Packing Build" mkdir -p $GITHUB_WORKSPACE/package - cd ./Builds + cd $BUILD_PATH zip $GITHUB_WORKSPACE/package/artifact.zip . -r echo artifact=package/artifact.zip >> $GITHUB_OUTPUT echo "Done"