From 54884fe6cc99444af0d254fb3d3b5ecc3cc4c813 Mon Sep 17 00:00:00 2001 From: BARICHELLO Date: Fri, 22 Mar 2019 00:35:39 -0300 Subject: [PATCH] Move variables to Ci panel; Update README --- .gitlab-ci.yml | 2 -- README.md | 9 +++++---- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index f1e64e1..57baeec 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -2,8 +2,6 @@ image: barichello/godot-ci:3.1 variables: EXPORT_NAME: gameoff - GIT_EMAIL: artur@barichello.me - GIT_USERNAME: abarichello stages: - export diff --git a/README.md b/README.md index f4460c2..d0cb97d 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,23 @@ # godot-ci -Docker image to deploy Godot Engine games +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 a 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: *Access `https://gitlab.com///settings/ci_cd` to edit:* |Variable|Description|Example| |-|-|-| -|$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` +| $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)
-