Skip to content
This repository was archived by the owner on Jun 12, 2018. It is now read-only.

Commit d8e3b60

Browse files
committed
v0.4.0
1 parent 6a8c9fe commit d8e3b60

File tree

4 files changed

+21
-17
lines changed

4 files changed

+21
-17
lines changed

docs/cli/commands.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
This is the easiest way to get started with Devstep. By running the command
1616
from your project's root, Devstep will:
1717

18-
1. Create a Docker container based on `fgrehm/devstep:v0.3.1` with project
18+
1. Create a Docker container based on `fgrehm/devstep:v0.4.0` with project
1919
sources bind mounted at `/workspace`.
2020
2. Detect and install project's dependencies on the new container using the
2121
available buildpacks.
@@ -44,7 +44,7 @@ devstep hack -p 80:8080 --link postgres:db --link memcached:mc -e DEVSTEP_BUNDLE
4444

4545
By running the command from your project's root, Devstep will:
4646

47-
1. Create a Docker container based on `fgrehm/devstep:v0.3.1` with project
47+
1. Create a Docker container based on `fgrehm/devstep:v0.4.0` with project
4848
sources bind mounted at `/workspace`.
4949
2. Detect and install project's dependencies on the new container using the
5050
available buildpacks.
@@ -53,7 +53,7 @@ By running the command from your project's root, Devstep will:
5353

5454
The `devstep/<PROJECT>` images act like snapshots of your project dependencies
5555
and will be used as the source image for subsequent `devstep` commands instead
56-
of the `fgrehm/devstep:v0.3.1` image.
56+
of the `fgrehm/devstep:v0.4.0` image.
5757

5858
For example, running a `devstep hack` after building the image will use `devstep/<PROJECT>:latest`
5959
as the base container for new "hacking sessions" so that you don't have to build
@@ -128,6 +128,7 @@ of choice.
128128

129129
* `info` - Show information about the current environment
130130
* `run` - Run a one off command against the current base image
131+
* `exec` - Run a one off command against the last container created for the current project
131132
* `binstubs` - Generate binstubs for the commands specified on devstep.yml
132133
* `clean` - Remove previously built images for the current environment
133134
* `pristine` - Rebuild project image from scratch

docs/cli/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The available options are described below:
1212
repository: 'repo/name'
1313

1414
# The image used by devstep when building environments from scratch
15-
# DEFAULT: 'fgrehm/devstep:v0.3.1'
15+
# DEFAULT: 'fgrehm/devstep:v0.4.0'
1616
source_image: 'source/image:tag'
1717

1818
# The host cache dir that gets mounted inside the container at `/home/devstep/cache`

docs/getting-started.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44
Devstep comes in two flavors, you can either use the provided CLI or you can build
55
on top of the provided images from `Dockerfile`s.
66

7-
Regardless of the flavor you choose, it is a good idea to `docker pull fgrehm/devstep:v0.3.1`
7+
Regardless of the flavor you choose, it is a good idea to `docker pull fgrehm/devstep:v0.4.0`
88
before creating your first container / image for a better user experience. Docker
99
will download that image as needed when using `Dockerfile`s but the Devstep CLI won't.
1010

1111
## Sanity check
1212
---------------
1313

1414
This project is being developed and tested on an Ubuntu 14.04 host with Docker
15-
1.4.0+, while it is likely to work on other distros / Docker versions /
15+
1.7.0, while it is likely to work on other distros / Docker versions /
1616
[boot2docker](http://boot2docker.io/), I'm not sure how it will behave on the wild.
1717

1818
Please note that the CLI is currently limited to connecting to a local `/var/run/docker.sock`
@@ -38,10 +38,10 @@ line to your `~/devstep.yml` so that the image is used as a source for your proj
3838
To install the CLI, you can run the one liner below and read on for more:
3939

4040
```sh
41-
L=$HOME/bin/devstep && curl -sL https://github.com/fgrehm/devstep-cli/releases/download/v0.3.1/linux_amd64 > $L && chmod +x $L
41+
L=$HOME/bin/devstep && curl -sL https://github.com/fgrehm/devstep-cli/releases/download/v0.4.0/linux_amd64 > $L && chmod +x $L
4242
```
4343

44-
_The snippet above assumes `$HOME/bin` is on your PATH, change `$HOME/bin` to
44+
_The snippet above assumes `$HOME/bin` is on your `PATH`, change `$HOME/bin` to
4545
an appropriate path in case your system is not configured like that._
4646

4747
### Doing a quick hack on a project
@@ -180,7 +180,7 @@ The `fgrehm/devstep` image is the base image used for Devstep environments and
180180
requires you to manually trigger the build:
181181

182182
```Dockerfile
183-
FROM fgrehm/devstep:v0.3.1
183+
FROM fgrehm/devstep:v0.4.0
184184

185185
# Add project to the image and build it
186186
ADD . /workspace

docs/introduction.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,28 +25,31 @@ is not an easy task for many people. Yes, there are plenty of platform specific
2525
images available for download on [Docker Hub](https://hub.docker.com/) but because
2626
Devstep's base image provides an environment that is [similar to Heroku's](https://github.com/progrium/cedarish),
2727
it should be capable of building and running a wide range of applications / tools
28-
/ libraries from a single image.
28+
/ libraries from a single image without the need to worry about writing `Dockerfile`s.
2929

30-
Devstep is also capable of reducing the disk space and initial configuration times by
31-
(optionally) caching packages on the host machine using a strategy similar to [vagrant-cachier's cache buckets](http://fgrehm.viewdocs.io/vagrant-cachier/how-does-it-work),
30+
With Devstep's CLI, we can also reduce the disk space and initial configuration
31+
times by (optionally) caching packages on the host machine using a strategy similar
32+
to [vagrant-cachier's cache buckets](http://fgrehm.viewdocs.io/vagrant-cachier/how-does-it-work),
3233
where project dependencies packages are kept on the host while its contents are
3334
extracted inside the container.
3435

3536

3637
## Usage
3738

3839
Devstep can be used to build development environments in at least two different
39-
ways: from the provided Golang CLI or from `Dockerfile`s. To run the images built,
40-
you can use the provided `devstep hack` command, use other tools (like [docker-compose](http://docs.docker.com/compose/))
40+
ways: from the provided CLI or from `Dockerfile`s. To run the images built, you
41+
can use the provided `devstep hack` command, use other tools (like [docker-compose](http://docs.docker.com/compose/))
4142
or just `docker run` them by hand.
4243

4344

4445
## What's included on the base [Docker image](https://registry.hub.docker.com/u/fgrehm/devstep/)?
4546

46-
That image is based on [`progrium/cedarish:cedar14`](https://github.com/progrium/cedarish),
47-
so everything that gets installed by it will be available for `fgrehm/devstep` images.
47+
That image is based on [Heroku's `cedar:14` image](https://registry.hub.docker.com/u/heroku/cedar/)
48+
which makes up for the [Cedar-14](https://devcenter.heroku.com/articles/cedar)
49+
stack. So everything that is available to it (and as a consequence, available to
50+
Heroku apps) will be available for `fgrehm/devstep` environments.
4851

49-
On top of `progrium/cedarish:cedar14`, we:
52+
On top of `heroku/cedar:14`, we:
5053

5154
* Create a `developer` user to avoid using `root` and creating files with wrong permissions during development.
5255
* Install some extra devel packages (like `libyaml-dev`) and other "nice to have"

0 commit comments

Comments
 (0)