A utility for building projects in OpenShift.
npm install os-build -g
os-build command [--options]
-
clone
- Clones the source code to a unique dir within the build volume. -
describe
- Prints the build configuration in yaml format. -
build
- Performs a build of the source code. -
runtime-build
- Performs a runtime build. -
runtime-tag
- Tags the runtime image with the value specified by--tag
. -
sync
- Rsyncs the current directory to the build volume.
-
--name
- Sets the name of the build. Defaults to name from--repo
if present. -
--repo
- A URL to a git repo to build. Defaults to remote origin of current directory. -
--contextPath
- A path within the source code to build. Defaults to.
. -
--build-number
- An identifier for the build. -
--namespace
- An OpenShift project/namespace for the resources to be created int. -
--volume
- A persistent volume claim and path to mount into the builder pods. Defaults tobuild-storage:/tmp/build-storage
. -
--tag
- The tag name to use when runningdocker.tag
. Defaults tolatest
. -
--executor-image
- The image to use for commands performed. Must havegit
,node
,oc
andos-build
(this module) installed.
The build.yaml
file informs the builder how to perform the build for the project. If a build.yaml
file is present in the projects source code it will take precedence. Attributes which are not present are loaded from templates based on the detected platform for the project - e.g. the nodejs
platform defaults will take effect if a package.json
is found in the project.
Commands executed during builds can be set by overriding individual properties in the project specific build.yaml
:
platform: nodejs
builder:
install: npm run install && npm run some-task
MIT