README
¶
OpenShift development tools
This repository provides few useful tools that developers can use when developing OpenShift.
Installation
If you have Go installed, you can install otp command using:
$ git clone https://github.com/mfojtik/dev-tools
$ cd dev-tools && make install
Configuration
The otp tool is smart enough to quess a lot of things based on your current directory
or the system environment. However, you must tell this utility what Github API token
it should use to authorize requests to Github.
To generate new Github token, navigate to Settings->Access Tokens
page and click "Generate new token". Then copy the generated token into an environment variable
you can append to your ~/.bash_profile (or any other file with more restrictive permissions):
$ echo "GITHUB_API_TOKEN=<token here>" >> ~/.bashrc
$ source ~/.bashrc
Usage
get
This command will attempt to guess the pull requests you have opened for the current branch.
The pull requests must be opened against the upstream remote (given that you are working on a branch
in your fork). Sample usage:
$ cd dev-tools && git checkout test
$ otp get
Searching pull request based on "mfojtik:test" ...
[OPEN] #1: "Test" (https://github.com/mfojtik/dev-tools/pull/1
$ otp get -n
1
Note that the -n options will cause the command to print just the numbers of
the pull requests found. By default, the otp get command searches only pull
requests that are "open".
test
In OpenShift we use special comments with tags to trigger testing in our CI (Jenkins).
Depending on what test you want to trigger, you can set --extended, --only-extended
or just simple test. Sample usage:
$ otp test $(otp get -n)
Pull request #1 tagged for test "https://github.com/mfojtik/dev-tools/pull/1#issuecomment-172376669"
$ otp test $(otp get -n) --only-extended --focus "build"
Pull request #1 tagged for test "https://github.com/mfojtik/dev-tools/pull/1#issuecomment-172376669"
$ otp test $(otp get -n) --extended --group networking"
Pull request #1 tagged for test "https://github.com/mfojtik/dev-tools/pull/1#issuecomment-172376669"
merge
We don't merge pull requests in OpenShift directly using Github. Instead we use our CI (Jenkins) to merge them using a merge queue. Sample usage:
$ otp merge $(otp get -n)
Pull request #1 tagged for merge "https://github.com/mfojtik/dev-tools/pull/1#issuecomment-172376669"
rebuild
When you modify a source code of an builder (typically pkg/build/builders),
you have to rebuild the builder Docker image in order to see the results in
OpenShift. OpenShift does not provide (yet) a way to rebuild just a single
builder and instead, you have to execute make release which can take horrible
amount of time. This command allows you to rebuild just a single image with
updated openshift binary. For that you need to first compile OpenShift (make build).
Then you can call rebuild as:
$ otp rebuild --image=openshift/origin-sti-builder
Rebuilding "openshift/origin-sti-builder" ...
$ otp rebuild --builders
Rebuilding "openshift/origin-docker-builder" ...
Rebuilding "openshift/origin-sti-builder" ...
Directories