Skip to content

Commit

Permalink
README: separate clever-specific vs general plugins
Browse files Browse the repository at this point in the history
  • Loading branch information
nathanleiby committed Mar 1, 2017
1 parent bc123df commit 6ac8d6b
Showing 1 changed file with 23 additions and 14 deletions.
37 changes: 23 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -17,23 +21,36 @@ 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.

```
$ ./circleci/npm-publish [NPM_TOKEN] [PACKAGE_DIR]
```

### Github Release
#### Github Release

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).

Expand All @@ -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.
Expand All @@ -54,19 +71,11 @@ $ ./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).

```
$ ./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]
```

0 comments on commit 6ac8d6b

Please sign in to comment.