From 6ac8d6b70e845e8b00da870b3af2ccbc0ad0d2ba Mon Sep 17 00:00:00 2001 From: Nathan Leiby Date: Wed, 1 Mar 2017 13:34:03 -0800 Subject: [PATCH] README: separate clever-specific vs general plugins --- README.md | 37 +++++++++++++++++++++++-------------- 1 file changed, 23 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 1f35323..4a89ce6 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,11 @@ Owned by `#eng-infra`. ## Scripts -### Docker +### General-purpose + +The following scripts don't rely on any Clever-specific tooling. + +#### Docker Logs into Docker registry, then builds and pushes docker image. Docker image is tagged with 7 character git commit SHA. @@ -17,7 +21,7 @@ Docker image is tagged with 7 character git commit SHA. $ ./circleci/docker-publish [DOCKER_USER] [DOCKER_PASS] [DOCKER_EMAIL] [ORG] ``` -### NPM Publish +#### NPM Publish Authenticates to NPM and publishes a package. @@ -25,7 +29,7 @@ Authenticates to NPM and publishes a package. $ ./circleci/npm-publish [NPM_TOKEN] [PACKAGE_DIR] ``` -### Github Release +#### Github Release Publishes content from `[ARTIFACTS_DIR]` as a Github Release. @@ -33,7 +37,20 @@ Publishes content from `[ARTIFACTS_DIR]` as a Github Release. $ ./circleci/github-release [GITHUB_TOKEN] [ARTIFACTS_DIR] ``` -### Catapult +#### Mongo install + +Installs a specific Mongo version, rather than the default version in CircleCI. +At time of writing, `v3.0.7` was default version in CircleCI's [Ubuntu 14.04 (Trusty) image](https://circleci.com/docs/build-image-trusty/#mongodb). + +``` +$ ./circleci/mongo-install [VERSION] +``` + +### Clever internal + +The following scripts depend on Clever-specific infrastructure and tooling. + +#### Catapult Publishes your application and build in [catapult](https://github.com/clever/catapult). @@ -43,7 +60,7 @@ $ ./circleci/catapult-publish [CATAPULT_URL] [CATAPULT_USER] [CATAPULT_PASS] [AP If you need to publish multiple applications, run this command once for each. -### Dapple +#### Dapple Deploys your application with [dapple](https://github.com/clever/dapple). Requires that you've first pushed the Docker image and published the application to Catapult. @@ -54,7 +71,7 @@ $ ./circleci/dapple-deploy [DAPPLE_URL] [DAPPLE_USER] [DAPPLE_PASS] [APP_NAME] If you need to deploy multiple applications, run this command once for each. -### Report-card +#### Report-card Runs [report-card](https://github.com/clever/report-card). @@ -62,11 +79,3 @@ Runs [report-card](https://github.com/clever/report-card). $ ./circleci/report-card [DOCKER_USER] [DOCKER_PASS] [DOCKER_EMAIL] [GITHUB_TOKEN] ``` -### Mongo install - -Installs a specific Mongo version, rather than the default version in CircleCI. -At time of writing, `v3.0.7` was default version in CircleCI's [Ubuntu 14.04 (Trusty) image](https://circleci.com/docs/build-image-trusty/#mongodb). - -``` -$ ./circleci/mongo-install [VERSION] -```