@@ -24,7 +24,7 @@ For developing Heron, you will need to compile it for the environment that you
24
24
want to use it in. If you'd like to use Docker to create that build environment,
25
25
Heron provides a convenient script to make that process easier.
26
26
27
- Currently, only Ubuntu 14.04, Ubuntu 15.10 , and CentOS 7 are supported, but if you
27
+ Currently, only Ubuntu 14.04, Ubuntu 18.04 , and CentOS 7 are supported, but if you
28
28
need another platform there are instructions for adding new ones
29
29
[ below] ( #contributing-new-environments ) .
30
30
@@ -60,7 +60,7 @@ Running the script by itself will display usage information:
60
60
```
61
61
Usage: docker/build-artifacts.sh <platform> <version_string> [source-tarball] <output-directory>
62
62
63
- Platforms Supported: darwin, ubuntu14.04, ubuntu15.10 , centos7
63
+ Platforms Supported: darwin, ubuntu14.04, ubuntu18.04 , centos7
64
64
65
65
Example:
66
66
./build-artifacts.sh ubuntu14.04 0.12.0 .
@@ -113,6 +113,39 @@ heron-layer-0.12.0-ubuntu14.04.tar
113
113
heron-tools-0.12.0-ubuntu14.04.tar.gz
114
114
```
115
115
116
+ ## Set Up A Docker Based Development Environment
117
+
118
+ In case you want to have a development environment instead of making a full build,
119
+ Heron provides two helper scripts for you. It could be convenient if you don't want
120
+ to set up all the libraries and tools on your machine directly.
121
+
122
+ The following commands are to create a new docker image with a development environment
123
+ and start the container based on it:
124
+ ``` bash
125
+ $ cd /path/to/heron/repo
126
+ $ docker/scripts/dev-env-create.sh heron-dev
127
+ ```
128
+
129
+ After the commands, a new docker container is started with all the libraries and tools
130
+ installed. The operation system is Ubuntu 18.04 by default. Now you can build Heron
131
+ like:
132
+ ``` bash
133
+ \# bazel build --config=ubuntu scripts/packages:binpkgs
134
+ \# bazel build --config=ubuntu scripts/packages:tarpkgs
135
+ ```
136
+
137
+ The current folder is mapped to the '/heron' directory in the container and any changes
138
+ you make on the host machine will be reflected in the container. Note that when you exit
139
+ the container and re-run the script, a new container will be started with a fresh new
140
+ environment.
141
+
142
+ When a development environment container is running, you can use the follow script
143
+ to start a new terminal in the container.
144
+ ``` bash
145
+ $ cd /path/to/heron/repo
146
+ $ docker/scripts/dev-env-run.sh heron-dev
147
+ ```
148
+
116
149
## Contributing New Environments
117
150
118
151
You'll notice that there are multiple
0 commit comments