Skip to content

Commit

Permalink
Updates for the 0.2 release.
Browse files Browse the repository at this point in the history
All Dockerfile instructions are now supported.
  • Loading branch information
thedodd committed Dec 9, 2018
1 parent 557e494 commit 2b4c966
Show file tree
Hide file tree
Showing 5 changed files with 518 additions and 15 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[package]
name = "dockerfile"
description = "A Rust library for dynamically generating Dockerfiles."
version = "0.1.1"
version = "0.2.0"

authors = ["Anthony Dodd <[email protected]>"]
categories = ["api-bindings", "config", "data-structures", "development-tools"]
Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ A Rust library for dynamically generating Dockerfiles.

The use case this crate was originally built for was to build Docker images from a worker service running in Kubernetes for client workloads. This is definitely not the only pattern that is supported. The generated Dockerfiles could be persisted somewhere or discarded immediately after use. The containers generated are standard containers, built according to the Dockerfiles you generated.

All of the Dockerfile instructions are supported in raw form as of 2018.12.09. There is an issue open to add more structured and type-safe interfaces for the instructions which need it.

### get started
First you will need to add this to your `Cargo.toml` dependencies.

Expand Down Expand Up @@ -50,4 +52,4 @@ CMD echo 'Hello. Goodbye.'
```

### development
This crate is in an early state, and there are a few additional things to be done with it. I would like to experiment with adding constructors for the various forms of instructions; EG, offer a constructor for `CMD` which takes an `impl Iterator<Item=AsRef<str>>` for building the form `CMD ["arg0", "arg1"]` &c. Not sure on that yet.
I would like to have this crate offer a type-safe interface for constructing the various Dockerfile instructions. This will help reduce bugs which could only be found once you actually attempt to invoke the docker build. I would like to experiment with adding constructors for the various forms of instructions; EG, offer a constructor for `CMD` which takes an `impl Iterator<Item=AsRef<str>>` for building the form `CMD ["arg0", "arg1"]` &c.
Loading

0 comments on commit 2b4c966

Please sign in to comment.