Welcome in PR automation plugins Arquillian project. These plugins are based on Prow sub project of Kubernetes Test Infrastructure.
You need to have following packages in place:
-
git
-
make
-
go
(>= v1.10.2
) -
dep
for dependency management
Assuming that you have all the Golang prerequisites in place (such as $GOPATH
), clone the repository first:
$ git clone https://github.com/arquillian/ike-prow-plugins $GOPATH/src/github.com/arquillian/ike-prow-plugins
Note
|
Have a look how Go Version Manager can help you simplifying configuration and management of different versions of Go. |
Note
|
You can also use setup.sh which takes care of all of the above. Simply execute$ curl -sSL https://git.io/vxnSk | bash and you are all set. |
The complete documentation can be found at http://arquillian.org/ike-prow-plugins.
You can also generate it locally. All you need to have in place is Docker. Then simply execute:
./.asciidoctor/generate.sh
and you are set. You will find generated documentation in the gh-pages
folder.
On Linux you can combine it with following command:
./.asciidoctor/generate.sh && xdg-open gh-pages/index.html &>/dev/null
This will generate the documentation and open it in the browser.