diff --git a/docs/development/contributor_guidelines.rst b/docs/development/contributor_guidelines.rst index 63a8dc87eb..a0ee5357ed 100644 --- a/docs/development/contributor_guidelines.rst +++ b/docs/development/contributor_guidelines.rst @@ -21,7 +21,7 @@ requests to ``develop``. Automated Testing ----------------- -When a pull request is submitted, we have Travis CI automatically run the +When a pull request is submitted, we have Circle CI automatically run the SecureDrop test suites, which consist of: #. Unit tests of the Python SecureDrop application code. @@ -126,8 +126,8 @@ such as the right to push new branches or to merge pull requests. There is no formal process at the moment but the general idea is that any contributor with the right technical and social skills is entitled to ask. The people who have the power to grant such -privileges are commited to do so in a transparent way to avoid any -dispute. +privileges are committed to do so in a transparent way to avoid any +disputes. Other Tips ---------- diff --git a/docs/development/testing_continuous_integration.rst b/docs/development/testing_continuous_integration.rst index b143a56fc7..914ed273b5 100644 --- a/docs/development/testing_continuous_integration.rst +++ b/docs/development/testing_continuous_integration.rst @@ -3,23 +3,10 @@ Testing: CI =========== -The SecureDrop project uses multiple automated third-party solutions -for running automated test suites on code changes: +The SecureDrop project uses CircleCI_ for running automated test suites on code changes: - * Travis_ - * CircleCI_ - -.. _Travis: https://travis-ci.org/freedomofpress/securedrop/ .. _CircleCI: http://circleci.com/gh/freedomofpress/securedrop/ -Travis tests ------------- - -The Travis_ test suite provisions the development VM and runs the application -test suite against the latest version of the code. It also performs basic -linting and validation, e.g. checking for mistakes in the Sphinx documentation -(see :doc:`documentation_guidelines`). - CI test layout -------------- @@ -29,10 +16,9 @@ The relevant files for configuring the CI tests are: :: ├── devops │ ├── inventory <-- environment specific inventory │ ├── playbooks <-- playbooks to start CI boxes - │ ├── scripts <-- shell wrapper scripts + │ ├── scripts <-- shell wrapper scripts │ ├── templates <-- contains templates for ansible tasks │ └── vars <-- environment specific variables - ├── .travis.yml <--- config for development tests on travis └── Makefile <-- defines make task shortcuts The files under ``devops/`` are used to create a minimized staging environment @@ -46,6 +32,9 @@ The staging environment tests will run automatically in CircleCI, when changes are submitted by Freedom of the Press Foundation staff (i.e. members of the ``freedomofpress`` GitHub organization). +It also performs basic linting and validation, e.g. checking for mistakes in +the Sphinx documentation. + .. tip:: You will need an Amazon Web Services EC2 account to proceed. See the `AWS Getting Started Guide`_ for detailed instructions.