Adding CI to your Fork
Before we start adding CI it’s important you have a GitHub account and know how to fork repositories. In case you don’t, you should have a look into our Git Tutorial.
Travis is used to confirm that the tools install and build properly. It also runs the tests and confirms all test cases pass and have 100% coverage. These are examples of travis CI checks used in Addy repositories:
To run identical CI checks in travis you will need to configure your forked repository and to do that follow the steps mentioned below.
- Go to travis-ci.org and create an account. You can simply use your GitHub account for that.
- On the top left corner you will see a “+” icon beside “My Repositories”. Click on that, and it will take you to your travis-ci profile.
- Sync your account with GitHub by clicking on the top right button saying “Sync account”.
- Find the forked Addy repository in the list and enable builds for it.
- Travis CI requires a .travis.yml file containing the settings and build instructions. Your forked repository from Addy will already have that file.
- Watch the builds at travis-ci.org/username/repository/builds.
We require 100% test coverage, and to test that we use codecov.io which takes data from all other CI to confirm its coverage. Follow the instructions here, to enable getting coverage reports for your forked repository.
- Go to codecov.io and sign up using your GitHub account.
- Click on your username, and that will take you to a page where the repositories that use codecov are listed.
- Click on “Add new repository” and it will take you to a page that lists all your repositories. Choose the forked repository for which you want to enable codecov.
- Like other CI, this also has a configuration file, .codecov.yml file which your forked repository will already have. The CI uploads the test reports to codecov, which then creates an overall coverage report.
- You can watch the reports at codecov.io/gh/username/repository
Code of Conduct »