openshift/source-to-image
1
0
Fork 0
mirror of https://github.com/openshift/source-to-image.git synced 2026-02-05 12:44:54 +01:00
Code Issues Releases Activity

Fixed typo in save-artifacts description, added test/run description, release link and godoc reference to README.md

Browse Source
This commit is contained in:
Maciej Szulik
2015-01-28 10:43:18 +01:00
parent 634d2ca210
commit fafac1c1ee
2 changed files with 26 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -1,4 +1,8 @@
# source-to-image (sti) [![Build Status](https://travis-ci.org/openshift/source-to-image.svg?branch=master)](https://travis-ci.org/openshift/source-to-image)
# source-to-image (sti)
[![GoDoc](https://godoc.org/github.com/openshift/source-to-image?status.png)](https://godoc.org/github.com/openshift/source-to-image)
[![Travis](https://travis-ci.org/openshift/source-to-image.svg?branch=master)](https://travis-ci.org/openshift/source-to-image)
Source-to-image (`sti`) is a tool for building reproducible docker images. `sti` produces
ready-to-run images by injecting source code into a docker image and *assembling*
@@ -93,7 +97,8 @@ $ hack/build-go.sh
# Getting Started
You can start using `sti` right away with the following test sources and publicly available images:
You can start using `sti` right away (see [releases](https://github.com/openshift/source-to-image/releases))
with the following test sources and publicly available images:
```
$ sti build git://github.com/pmorie/simple-ruby openshift/ruby-20-centos test-ruby-app

20
docs/builder_image.md
View File

@@ -43,6 +43,7 @@ sources are already there.
* optional:
* [save-artifacts](#save-artifacts)
* [usage](#usage)
* [test/run](#test/run)
All of the scripts can be written in any programming language, as long as it is
executable inside the builder image.
@@ -99,7 +100,7 @@ The `run` script is responsible for executing your application.
## save-artifacts
The `save-artifacts` script is responsible for gathering all the dependencies which
existence can speed up the following build processes (eg. for Ruby - Gemfiles,
existence can speed up the following build processes (eg. for Ruby - gems installed by Bundler,
for Java - `.m2` contents, etc.) into a tar file and stream it to the standard output.
#### Example `save-artifacts` script:
@@ -132,3 +133,20 @@ This is a STI sample builder image, to use it, install
https://github.com/openshift/source-to-image
EOF
```
## test/run
The `test/run` script is for you, as the builder image author, to create a simple
process to checks if the image is working correctly. The proposed flow of that process
should be following:
1. Build the image.
1. Run the image to verify `usage` script.
1. Run `sti build` to verify `assemble` script.
1. (optional) Run `sti build` once more to verify `save-artifacts` script and
`assemble`'s restore artifacts functionality.
1. Run the image to verify the test application is working.
**NOTE** The suggested place to put your test application which should be built by your
`test/run` script is `test/test-app` in your image repository, see
[sti create](https://github.com/openshift/source-to-image/blob/master/docs/cli.md#sti-create).