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

Commit 2af9956

Browse files
committed
[master] update doc
1 parent 6be7f32 commit 2af9956

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,13 @@ This plugin allows to add "Execute shell in Hyper_" build step into your job.
77

88
- [Features](#features)
99
- [Use plugin](#use-plugin)
10+
- [Prerequisites](#prerequisites)
1011
- [Install plugin by manually](#install-plugin-by-manually)
1112
- [Config plugin](#config-plugin)
1213
- [Config job](#config-job)
1314
- [View build result](#view-build-result)
14-
- [Build](#build)
15+
- [Build plugin](#build-plugin)
16+
- [Prerequisites](#prerequisites)
1517
- [Compile](#compile)
1618
- [Test](#test)
1719
- [Package](#package)
@@ -29,10 +31,18 @@ Plugin currently support following features:
2931

3032
# Use plugin
3133

34+
## Prerequisites
35+
36+
- Jenkins
37+
- hyper-build-step-plugin.hpi
38+
- Hyper_ credential
39+
3240
## Install plugin by manually
3341

3442
open Jenkins Web UI in web browser
3543

44+
get pre-build `hyper-build-step-plugin.hpi` [here](target/hyper-build-step-plugin.hpi)
45+
3646
```
3747
Manage Jenkins -> Manage Plugins -> Advanced -> Upload Plugin
3848
```
@@ -41,7 +51,7 @@ Manage Jenkins -> Manage Plugins -> Advanced -> Upload Plugin
4151

4252
## Config plugin
4353

44-
login https://console.hyper.sh to get a credential.
54+
login https://console.hyper.sh to get a `Hyper_ credential`.
4555

4656
```
4757
Manage Jenkins -> Configure System -> Hyper Install And Config
@@ -63,7 +73,12 @@ Config -> Build -> Execute shell in Hyper_
6373
![](images/view-result.PNG)
6474

6575

66-
# Build
76+
# Build plugin
77+
78+
## Prerequisites
79+
80+
- java 1.7+
81+
- maven 3+
6782

6883
## Compile
6984
```

0 commit comments

Comments
 (0)