Move variables to Ci panel; Update README

This commit is contained in:
BARICHELLO
2019-03-22 00:35:39 -03:00
parent 0bcd6746f9
commit 54884fe6cc
2 changed files with 5 additions and 6 deletions

View File

@@ -2,8 +2,6 @@ image: barichello/godot-ci:3.1
variables: variables:
EXPORT_NAME: gameoff EXPORT_NAME: gameoff
GIT_EMAIL: artur@barichello.me
GIT_USERNAME: abarichello
stages: stages:
- export - export

View File

@@ -1,11 +1,11 @@
# godot-ci # godot-ci
Docker image to deploy Godot Engine games Docker image to export Godot Engine games and deploy web exports.
## Docker Hub ## Docker Hub
https://hub.docker.com/r/barichello/godot-ci/ https://hub.docker.com/r/barichello/godot-ci/
## Usage example ## Usage example
A `.gitlab-ci.yml` is included in this project as a usage example.<br> 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).<br>
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: 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/<username>/<repo-name>/settings/ci_cd` to edit:* *Access `https://gitlab.com/<username>/<repo-name>/settings/ci_cd` to edit:*
@@ -13,10 +13,11 @@ After adapting the paths and names according to your project needs you will need
|Variable|Description|Example| |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 username>:<deploy token>@github.com/<username>/<repository>.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 username>:<deploy token>@github.com/<username>/<repository>.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`<br> Others variables are set automatically by the `gitlab-runner`<br>
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. 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:<br> Check a usage example in this test project:<br>
- [`aBARICHELLO/game-off`](https://github.com/aBARICHELLO/game-off)<br> - [`aBARICHELLO/game-off`](https://github.com/aBARICHELLO/game-off)<br>