evennia/docs/source/Coding/Continuous-Integration-Travis.md

# Continuous integration with Travis

[Travis CI](https://travis-ci.org/) is an online service for checking, validating and potentially 
deploying code automatically. It can check that every commit is building successfully after every
commit to its Github repository. 

If your game is open source on Github you may use Travis for free. 
See [the Travis docs](https://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:

``` yaml
language: python
python:
  - "3.10"
install:
  - git clone https://github.com/evennia/evennia.git
  - cd evennia
  - pip install -e .
  - cd $TRAVIS_BUILD_DIR
script:
  - evennia migrate
  - evennia test --settings settings.py .
```

This will tell travis how to download Evennia, install it, set up a database and then run 
your own test suite (inside the game dir). Use `evennia test evennia` if you also want to 
run the Evennia full 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.

For properly testing your game you of course also need to write unittests. 
The [Unit testing](./Unit-Testing.md) doc page gives some ideas on how to set those up for Evennia. 
You should be able to refer to that for making tests fitting your game.