Files
SHS_jenkins_lib/README.md
2024-04-24 09:39:33 +03:00

32 lines
918 B
Markdown

# Helper class for Jenkins
This repo add functionality for automate building with SHS plugin.
## Setup
First install [SHS.Platforms](https://git.shstk.ru/SHS/jenkins_lib) Jenkins library
You should add `SHSSDK_DIR` environment to your Jenkins with path to local directory on server
where all plugins will be saved. SHS Server plugins manager works with this directory.
Next you should register this library in Jenkins -> System settings -> Global Pipeline Libraries:
* Library name: `SHS.SDK`
* Default version: `master`
* Project Repository: `https://git.shstk.ru/SHS/SHS_jenkins_lib.git`
## API
`org.SHS.SDK` Class:
* `build()` - build plugin for all major SHS versions for all platforms, then register for further autobuild on SHS change
## Usage
Typically *any* plugin Jenkinfile is like this:
```
@Library(['SHS.Platforms', 'SHS.SDK']) _
node {
def sdk = new org.SHS.SDK(this)
sdk.build()
}
```