# jenkins-shared-libraries

**Repository Path**: sampsonye/jenkins-shared-libraries

## Basic Information

- **Project Name**: jenkins-shared-libraries
- **Description**: No description available
- **Primary Language**: Groovy
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2022-01-04
- **Last Updated**: 2022-01-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

#  jenkins-shared-libraries
 
jenkins公共类库：提供Jenkins流水线使用的公共方法。
 
## Getting Started
 
* 仓库中每一个groovy类，均为一个groovy的共享方法，可以直接使用。
* 如需开启共享类库功能，需要在 
> Jenkins-系统管理-系统配置-Global Pipeline Libraries 
中配置共享类库的git仓库地址，以开启共享类库功能
* 在Jenkins中配置成功后，即可在Jenkins流水线中直接调用。
  
## Demo

例如，想在Jenkinsfile中调用日期的格式化输出方法，如下：
```

stages {
        stage('测试') {
            steps {
                sh "echo " + getDate()
            }
        }
    }

```

## Documents

目前实现的公共类库方法说明如下：
* getDate(): 获取 yyyy-MM-dd 格式日期
* getVersion(buildNumber): 获取 yyyy-MM-dd-buildNumber 格式版本号
* successPush(robotId, jobName, changeTitle, buildUrl = ''): 构建成功时向钉钉推送构建成功消息，robotId：钉钉机器人Id（此机器人需要在Jenkins系统配置中配置过）；jobName：工程名；changeTitle: git改动标题；buildUrl（可空）：构建地址。
* errorPush(robotId, jobName, changeTitle, buildUrl = ''): 构建成功时向钉钉推送构建成功消息，robotId：钉钉机器人Id（此机器人需要在Jenkins系统配置中配置过）；jobName：工程名；changeTitle: git改动标题；buildUrl（可空）：构建地址。
* log.info: 属性写法示例。log.warning: 属性写法示例。

## Deployment
 
此仓库所使用的语言为 *Groovy* ，语法请参照groovy语法。
如需添加公共方法，请参照 *getDate.groovy* 文件。
如需添加公共属性，请参照 *log.groovy* 文件。
  
## Caution
注意：Jenkins并不支持全量groovy语法，详情参考Jenkins流水线官方文档，因此建议仅实现公共方法。

## Acknowledgments
 
* [Jenkins官方文档-区别普通groovy](https://www.jenkins.io/zh/doc/book/pipeline/syntax/#%E5%8C%BA%E5%88%AB%E6%99%AE%E9%80%9A-groovy)
* [groovy官方文档-语法](http://www.groovy-lang.org/syntax.html)