Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-20 06:46:31 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fixed all links

Browse source
This commit is contained in:
Griatch 2020-10-11 19:31:05 +02:00
parent d4f1733bc7
commit 26f8ba3f71
175 changed files with 11972 additions and 4443 deletions
Download patch file Download diff file Expand all files Collapse all files

38
docs/source/Using-Travis.md
View file

@ -1,25 +1,37 @@
# Using Travis
Evennia uses [Travis CI](http://travis-ci.org/) to check that it's building successfully after every commit to its Github repository (you can for example see the `build: passing` badge at the top of Evennia's [Readme file](https://github.com/evennia/evennia)). If your game is open source on Github you may also use Travis for free. See [the Travis docs](http://docs.travis-ci.com/user/getting-started/) for how to get started.
Evennia uses [Travis CI](http://travis-ci.org/) to check that it's building successfully after every
commit to its Github repository (you can for example see the `build: passing` badge at the top of
Evennia's [Readme file](https://github.com/evennia/evennia)). If your game is open source on Github
you may use Travis for free. See [the Travis docs](http://docs.travis-ci.com/user/getting-started/)
for how to get started.
After logging in you will get to point Travis to your repository on github. One further thing you need to set up yourself is a Travis config file named `.travis.yml` (note the initial period `.`). This should be created in the root of your game directory. The idea with this file is that it describes what Travis needs to import and build in order to create an instance of Evennia from scratch and then run validation tests on it. Here is an example:
After logging in you need to point Travis to your repository on github. One further thing you need
to set up yourself is a Travis config file named `.travis.yml` (note the initial period `.`). This
should be created in the _root_ of your game directory.
``` yaml
dist: xenial
language: python
cache: pip
python:
- "2.7"
- "3.7"
- "3.8"
install:
- git clone https://github.com/evennia/evennia.git
- cd evennia
- pip install -e .
- cd $TRAVIS_BUILD_DIR
- git clone https://github.com/evennia/evennia.git ../evennia
- pip install -e ../evennia
script:
- evennia migrate
- evennia test evennia
- evennia test
- evennia test --settings settings.py
```
This will tell travis how to download Evennia, install it, set up a database and then run the test suite.
You need to add this file to git (`git add .travis.yml`) and then commit your changes before Travis will be able to see it.
Here we tell Travis how to download and install Evennia into a folder a level up from your game dir.
It will then install the server (so the `evennia` command is available) and run the tests only for
your game dir (based on your `settings.py` file in `server/conf/`).
For properly testing your game you of course also need to write unittests. [We have a page](./Unit-Testing) on how we set those up for Evennia, you should be able to refer to that for making tests fitting your game.
Running this will not actually do anything though, because there are no unit tests in your game dir
yet. [We have a page](./Unit-Testing) on how we set those up for Evennia, you should be able to refer
to that for making tests fitting your game.