Skip to content
This repository was archived by the owner on Feb 8, 2021. It is now read-only.

Commit 6a23c27

Browse files
committed
[master] update README, add MIT LICENSE
1 parent b046ad8 commit 6a23c27

File tree

2 files changed

+69
-2
lines changed

2 files changed

+69
-2
lines changed

LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2016 HyperHQ Inc
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

README.md

100644100755
+48-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,48 @@
1-
# hyper-build-step-plugin
2-
Build step plugin for integrate Jenkins with Hyper_(rely on hyper-commons-plugin)
1+
hyper-build-step-plugin
2+
=======================
3+
4+
This plugin allows to add "Execute shell in Hyper_" build step into your job.
5+
6+
# Features
7+
Plugin currently support following features:
8+
9+
- Install hyper cli
10+
- Set Hyper_ credentials
11+
- Support "Execute shell in Hyper_" build step in to job
12+
13+
# Build
14+
15+
## Compile
16+
```
17+
$ mvn compile
18+
```
19+
20+
## Test
21+
```
22+
//compile + test
23+
$ mvn test
24+
```
25+
26+
## Package
27+
28+
> **output**: target/hyper-build-step-plugin.hpi
29+
30+
```
31+
//compile + test + package
32+
$ mvn package
33+
34+
//compile + package
35+
$ mvn package -DskipTests
36+
```
37+
38+
## Install
39+
40+
> **target**: ~/.m2/repository/hyper-build-step/hyper-build-step-plugin/1.0-SNAPSHOT/hyper-build-step-plugin-1.0-SNAPSHOT.hpi
41+
42+
```
43+
//compile + test + package + install
44+
$ mvn install
45+
46+
//compile + package + install
47+
$ mvn install -DskipTests
48+
```

0 commit comments

Comments
 (0)