Move EXPORT_NAME to CI panel
README cleanup
This commit is contained in:
23
README.md
23
README.md
@@ -1,23 +1,28 @@
|
||||
# godot-ci
|
||||
Docker image to export Godot Engine games and deploy web exports.
|
||||
|
||||
<img src="https://i.imgur.com/nwZHG4f.png" width=450>
|
||||
|
||||
## 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).<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:
|
||||
## How To Use
|
||||
|
||||
*Access `https://gitlab.com/<username>/<repo-name>/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:<br>
|
||||
|
||||
- [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/<username>/<repo-name>/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 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>
|
||||
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>
|
||||
- [`aBARICHELLO/game-off`](https://github.com/aBARICHELLO/game-off)<br>
|
||||
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).<br>
|
||||
|
||||
Reference in New Issue
Block a user