diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 1ad10bebc3d2..7ac9ad7700b7 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -240,6 +240,31 @@ can build the docs via:: $ tox -e docs +Travis Configuration and Build Optimizations +-------------------------------------------- + +All build scripts in the ``.travis.yml`` configuration file which have +Python dependencies are specified in the ``tox.ini`` configuration. +They are executed in the Travis build via ``tox -e {ENV}`` where +``{ENV}`` is the environment being tested. + +By enumerating all Python dependencies in the ``tox`` configuration, +we can use our custom ``gcloud-python-wheels`` +`wheelhouse `__ +to speed up builds. This project builds and stores pre-built Python +`wheels `__ for every Python dependency our library +and tests have. + +If new ``tox`` environments are added to be run in a Travis build, they +should either be: + +- listed in ``[tox].envlist`` as a default environment + +- added to the list in the + `Travis environment variable `__ + ``EXTRA_TOX_ENVS``. This value is unencrypted in ``gcloud-python-wheels`` + to make ongoing maintenance easier. + Contributor License Agreements ------------------------------ diff --git a/scripts/update_wheels_project.sh b/scripts/update_wheels_project.sh index 44eaa151c6aa..78f3c00b516c 100755 --- a/scripts/update_wheels_project.sh +++ b/scripts/update_wheels_project.sh @@ -47,7 +47,6 @@ cd ${FRESH_REPO_DIR} git add LATEST_COMMIT git status -# H/T: http://stackoverflow.com/a/13730477/1068170 -git commit -m "Latest wheels build by travis-ci. [ci skip]" +git commit -m "Main project gcloud-python has been updated." git status git push origin master