You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@couchdb.apache.org by wo...@apache.org on 2018/07/10 17:08:36 UTC
couchdb-ci git commit: Fully document build.sh script
Repository: couchdb-ci
Updated Branches:
refs/heads/master 5dda73dee -> 46a8e4279
Fully document build.sh script
Project: http://git-wip-us.apache.org/repos/asf/couchdb-ci/repo
Commit: http://git-wip-us.apache.org/repos/asf/couchdb-ci/commit/46a8e427
Tree: http://git-wip-us.apache.org/repos/asf/couchdb-ci/tree/46a8e427
Diff: http://git-wip-us.apache.org/repos/asf/couchdb-ci/diff/46a8e427
Branch: refs/heads/master
Commit: 46a8e427935e368e615e5c778a28b70b16dc7b36
Parents: 5dda73d
Author: Joan Touzet <wo...@apache.org>
Authored: Tue Jul 10 10:08:25 2018 -0700
Committer: Joan Touzet <wo...@apache.org>
Committed: Tue Jul 10 10:08:25 2018 -0700
----------------------------------------------------------------------
README.md | 26 ++++++++++++++++++++++++++
1 file changed, 26 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/couchdb-ci/blob/46a8e427/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 8ef8ca2..0215783 100644
--- a/README.md
+++ b/README.md
@@ -52,6 +52,32 @@ ERLANGVERSION=default ./build.sh platform ubuntu-trusty
# Useful things you can do
+## Full `build.sh` options
+
+```
+Recognized commands:
+ clean <plat> Removes all images for <plat>.
+ clean-all Cleans all images for all platforms.
+ base <plat> Builds the base (no JS/Erlang) image for <plat>.
+ base-all Builds all base (no JS/Erlang) images.
+ js Builds the JS packages for <plat>.
+ js-all Builds the JS packages for all platforms.
+ js-no-rebuild Builds the JS packages for <plat> without rebuilding
+ the base image first.
+ js-all-no-rebuild Same as above, with the same condition.
+ js-upload <plat> Uploads the JS packages for <plat> to bintray.
+ Requires BINTRAY_USER and BINTRAY_API_KEY env vars.
+ platform <plat> Builds the image for <plat> with Erlang & JS support.
+ platform-all Builds all images with Erlang and JS support.
+ platform-upload Uploads the couchdbdev/* images to Docker Hub.
+ Requires appropriate credentials.
+ platform-upload-all Uploads all the couchdbdev/* images to Docker Hub.
+ couch <plat> Builds and tests CouchDB for <plat>.
+ couch-all Builds and tests CouchDB on all platforms.
+ couch-pkg <plat> Builds CouchDB packages for <plat>.
+ couch-pkg-all Builds CouchDB packages for all platforms.
+```
+
## Interactively working in a built container
After building the image as above: