Skip to content

Commit 5d9b46a

Browse files
committed
Updating CONTRIBUTING to describe build optimizations.
1 parent 15854bd commit 5d9b46a

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

CONTRIBUTING.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -240,6 +240,32 @@ can build the docs via::
240240

241241
$ tox -e docs
242242

243+
Travis Configuration and Build Optimizations
244+
--------------------------------------------
245+
246+
All build scripts in the ``.travis.yml`` configuration file which have
247+
Python dependencies are specified in the ``tox.ini`` configuration.
248+
They are executed in the Travis build via ``tox -e {ENV}`` where
249+
``{ENV}`` is the environment being tested.
250+
251+
By enumerating all Python dependencies in the ``tox`` configuration,
252+
we can use our custom ``gcloud-python-wheels``
253+
`wheelhouse <https://github.com/GoogleCloudPlatform/gcloud-python-wheels>`__
254+
to speed up builds. This project builds and stores pre-built Python
255+
`wheels <http://pythonwheels.com>`__ for every Python dependency our library
256+
and tests have.
257+
258+
If new ``tox`` environments are added to be run in a Travis build, they
259+
should either be:
260+
261+
- listed in ``[tox].envlist`` as a default environment
262+
263+
- added to the list in the
264+
`Travis environment variable <http://docs.travis-ci.com/user/environment-variables/#Using-Settings>`__
265+
``EXTRA_TOX_ENVS``. The current value is::
266+
267+
EXTRA_TOX_ENVS="coveralls regression"
268+
243269
Contributor License Agreements
244270
------------------------------
245271

0 commit comments

Comments
 (0)