From 06e3f5df22720c4145d82e5f253e9a56fdd3d910 Mon Sep 17 00:00:00 2001 From: Shannon Coen Date: Wed, 17 Jun 2015 14:22:17 -0700 Subject: [PATCH 1/2] Update README.md --- README.md | 48 ++++++++++++++++++++++++------------------------ 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 79b3302b4..24c1623e1 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,9 @@ # Cloud Foundry Routers [BOSH release] ----- This repo is a [BOSH](https://github.com/cloudfoundry/bosh) release for deploying TCP Router and associated tasks. The TCP Router adds non-HTTP routing capabilities to Cloud Foundry. ----- ## Developer Workflow When working on individual components of TCP Router, work out of the submodules under `src/`. @@ -14,30 +12,39 @@ See [Initial Setup](#initial-setup). Run the individual component unit tests as you work on them using [ginkgo](https://github.com/onsi/ginkgo). ---- -## Initial Setup +Commits to this repo should be submitted on the Develop branch -This BOSH release doubles as a `$GOPATH`. It will automatically be set up for -you if you have [direnv](http://direnv.net) installed. +## Get the code - # fetch release repo +1. Fetch release repo + + ``` mkdir -p ~/workspace cd ~/workspace git clone https://github.com/cloudfoundry-incubator/cf-routing-release.git cd cf-routing-release/ + ``` + + +1. Automate `$GOPATH` and `$PATH` setup + + This BOSH release doubles as a `$GOPATH`. It will automatically be set up for you if you have [direnv](http://direnv.net) installed. + - # automate $GOPATH and $PATH setup + ``` direnv allow + ``` + + If you do not wish to use direnv, you can simply `source` the `.envrc` file in the root of the release repo. You may manually need to update your `$GOPATH` and `$PATH` variables as you switch in and out of the directory. - # initialize and sync submodules - git submodule init - git submodule update -If you do not wish to use direnv, you can simply `source` the `.envrc` file in the root -of the release repo. You may manually need to update your `$GOPATH` and `$PATH` variables -as you switch in and out of the directory. +1. Initialize and sync submodules ---- + + ``` + ./scripts/update + ``` + ## Running Unit Tests 1. Install ginkgo @@ -48,8 +55,6 @@ as you switch in and out of the directory. ./scripts/run-unit-tests ---- - ## Deploying TCP Router to a local BOSH-Lite instance 1. Install and start [BOSH-Lite](https://github.com/cloudfoundry/bosh-lite), @@ -62,13 +67,9 @@ as you switch in and out of the directory. bosh download public stemcell (name) bosh upload stemcell (downloaded filename) -1. Checkout cf-routing-release (develop branch) from git +1. Clone the repo and sync submodules - cd ~/workspace - git clone https://github.com/cloudfoundry-incubator/cf-routing-release.git - cd ~/workspace/cf-routing-release/ - git submodule init - git submodule update + See [Get the code](#get-the-code) 1. Install spiff, a tool for generating BOSH manifests. spiff is required for running the scripts in later steps. The following installation method @@ -88,7 +89,6 @@ as you switch in and out of the directory. bosh -n upload release bosh -n deploy - ## Running Acceptance tests ### Using a BOSH errand on BOSH-Lite From c6a77e465b71197f6d814e6984d1be182f55d028 Mon Sep 17 00:00:00 2001 From: Shannon Coen Date: Thu, 18 Jun 2015 10:29:04 -0700 Subject: [PATCH 2/2] Update README.md --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 24c1623e1..566fdf950 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,11 @@ The TCP Router adds non-HTTP routing capabilities to Cloud Foundry. ## Developer Workflow When working on individual components of TCP Router, work out of the submodules under `src/`. -See [Initial Setup](#initial-setup). Run the individual component unit tests as you work on them using [ginkgo](https://github.com/onsi/ginkgo). -Commits to this repo should be submitted on the Develop branch +Commits to this repo (including Pull Requests) should be made on the Develop branch. ## Get the code