Skip to content

Commit 03d17ba

Browse files
committed
Merge pull request #309 from dhermes/wheels-tweak-and-docs
Wheels tweak and docs
2 parents 145c568 + 544c22c commit 03d17ba

File tree

2 files changed

+26
-2
lines changed

2 files changed

+26
-2
lines changed

CONTRIBUTING.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -251,6 +251,31 @@ can build the docs via::
251251

252252
$ tox -e docs
253253

254+
Travis Configuration and Build Optimizations
255+
--------------------------------------------
256+
257+
All build scripts in the ``.travis.yml`` configuration file which have
258+
Python dependencies are specified in the ``tox.ini`` configuration.
259+
They are executed in the Travis build via ``tox -e {ENV}`` where
260+
``{ENV}`` is the environment being tested.
261+
262+
By enumerating all Python dependencies in the ``tox`` configuration,
263+
we can use our custom ``gcloud-python-wheels``
264+
`wheelhouse <https://github.com/GoogleCloudPlatform/gcloud-python-wheels>`__
265+
to speed up builds. This project builds and stores pre-built Python
266+
`wheels <http://pythonwheels.com>`__ for every Python dependency our library
267+
and tests have.
268+
269+
If new ``tox`` environments are added to be run in a Travis build, they
270+
should either be:
271+
272+
- listed in ``[tox].envlist`` as a default environment
273+
274+
- added to the list in the
275+
`Travis environment variable <http://docs.travis-ci.com/user/environment-variables/#Using-Settings>`__
276+
``EXTRA_TOX_ENVS``. This value is unencrypted in ``gcloud-python-wheels``
277+
to make ongoing maintenance easier.
278+
254279
Contributor License Agreements
255280
------------------------------
256281

scripts/update_wheels_project.sh

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,6 @@ cd ${FRESH_REPO_DIR}
4747
git add LATEST_COMMIT
4848

4949
git status
50-
# H/T: http://stackoverflow.com/a/13730477/1068170
51-
git commit -m "Latest wheels build by travis-ci. [ci skip]"
50+
git commit -m "Main project gcloud-python has been updated."
5251
git status
5352
git push origin master

0 commit comments

Comments
 (0)