From 30f6b9a728abccd698d6efbdd2d10b4d03efb3f7 Mon Sep 17 00:00:00 2001 From: Barichello Date: Fri, 16 Aug 2019 00:36:35 -0300 Subject: [PATCH] Move EXPORT_NAME to CI panel README cleanup --- .gitlab-ci.yml | 3 --- README.md | 23 ++++++++++++++--------- 2 files changed, 14 insertions(+), 12 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 941a073..7539cef 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,8 +1,5 @@ image: barichello/godot-ci:3.1.1 -variables: - EXPORT_NAME: gameoff - stages: - export - deploy diff --git a/README.md b/README.md index d0cb97d..8ee2840 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,28 @@ # godot-ci Docker image to export Godot Engine games and deploy web exports. + + ## Docker Hub https://hub.docker.com/r/barichello/godot-ci/ -## Usage example -A `.gitlab-ci.yml` is included in this project as reference, a live example can be seen in [this project](https://github.com/aBARICHELLO/game-off).
-After adapting the paths and names according to your project needs you will need the following **Variables** set in GitLab for this image to work: +## How To Use -*Access `https://gitlab.com///settings/ci_cd` to edit:* +A `.gitlab-ci.yml` is included in this project as reference, for live projects using this image check the list below:
+ +- [Repository example](https://github.com/aBARICHELLO/game-off) +- [Deployed game example](http://barichello.me/game-off/) +- [Pipelines running](https://gitlab.com/BARICHELLO/game-off/pipelines) + +You will need the following **Variables** set in GitLab CI/CD panel for this script to work: + +*Access `https://gitlab.com///settings/ci_cd` to edit:* |Variable|Description|Example| |-|-|-| +| $EXPORT_NAME | Name given to the artifacts generated by godot. | `game-off` | $REMOTE_URL | The `git remote` where the web export will be hosted (in this case GitHub), it should contain your [deploy/personal access token](https://github.com/settings/tokens)|`https://:@github.com//.git` | $GIT_EMAIL | Git email of the account that will commit to the `gh-pages` branch. | `artur@barichello.me` | $GIT_USERNAME | Username of the account that will commit to the `gh-pages` branch. | `abarichello` -Others variables are set automatically by the `gitlab-runner`
-The included `gitlab-ci.yml` is set to only run the export jobs when you commit a new `git tag`, i suggest not using "." or "," in your tag's name since it messes with Godot's export system and will lead to failed jobs. - -Check a usage example in this test project:
-- [`aBARICHELLO/game-off`](https://github.com/aBARICHELLO/game-off)
+Others variables are set automatically by the `gitlab-runner`, see the documentation for [predefined variables](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html).