Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jenkinsci/ibm-ucdeploy-pipeline-plugin
A plugin for Jenkins automation server to communicate with IBM UrbanCode Deploy
https://github.com/jenkinsci/ibm-ucdeploy-pipeline-plugin
Last synced: 3 months ago
JSON representation
A plugin for Jenkins automation server to communicate with IBM UrbanCode Deploy
- Host: GitHub
- URL: https://github.com/jenkinsci/ibm-ucdeploy-pipeline-plugin
- Owner: jenkinsci
- License: apache-2.0
- Fork: true (killuazhu/Jenkins-Build-Step)
- Created: 2017-03-13T15:13:05.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-04-27T11:04:46.000Z (over 2 years ago)
- Last Synced: 2024-06-29T09:33:55.790Z (5 months ago)
- Language: Java
- Homepage: https://developer.ibm.com/urbancode/plugin/jenkins-2-0/
- Size: 305 KB
- Stars: 1
- Watchers: 8
- Forks: 2
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Overview
This is the [IBM UrbanCode Deploy](https://developer.ibm.com/urbancode/products/urbancode-deploy/) plugin for Jenkins Pipeline (Jenkins 2.0). This plugin is also referred to as the Build Steps plugin since you are able to interact with UrbanCode Deploy via a job step in Jenkins versus a post-processing action. The plugin allows you to upload component versions, create snapshots, and run processes among other things.
More information about this plugin is available [here](https://developer.ibm.com/urbancode/plugin/jenkins-2-0/) and [here](https://developer.ibm.com/urbancode/plugindoc/ibmucd/jenkins-pipeline-formerly-jenkins-2-0/).
## Installation
The compiled plugin is available for download on the [IBM UrbanCode website](https://developer.ibm.com/urbancode/plugin/jenkins-2-0/). Download the plugin from our website if you wish to skip the manual build step. No special steps are required for installation. Otherwise, clone this repository and run the `ant` command in the top level folder. This should compile the code and create a .hpi file within the /dist folder. Use this command if you wish to make local changes to the plugin. The build process will automatically install Apache Ivy if it is not previously installed.
### Support
Plug-ins downloaded directly from the [IBM UrbanCode Plug-ins microsite](https://developer.ibm.com/urbancode/plugins) are fully supported by IBM. Create a GitHub Issue or Pull Request for minor requests and bug fixes. For time sensitive issues that require immediate assistance, [file a PMR](https://www-947.ibm.com/support/servicerequest/newServiceRequest.action) through the normal IBM support channels. Plug-ins built externally or modified with custom code are supported on a best-effort-basis using GitHub Issues.
### Locally Build the Plug-in
This open source plug-in uses Ant as its build tool. [Install the latest version of Ant](http://ant.apache.org/manual/install.html) to build the plug-in locally. Build the plug-in by running the `ant` command in the plug-in's root directory. The plug-in distributable will be placed under the `dist` folder.
## Pipeline Examples
### Create Component Version
```groovy
node {
step([$class: 'UCDeployPublisher',
siteName: 'local',
component: [
$class: 'com.urbancode.jenkins.plugins.ucdeploy.VersionHelper$VersionBlock',
componentName: 'Jenkins',
createComponent: [
$class: 'com.urbancode.jenkins.plugins.ucdeploy.ComponentHelper$CreateComponentBlock',
componentTemplate: '',
componentApplication: 'Jenkins'
],
delivery: [
$class: 'com.urbancode.jenkins.plugins.ucdeploy.DeliveryHelper$Push',
pushVersion: '${BUILD_NUMBER}',
baseDir: 'jobs\\test-ucd\\workspace\\build\\distributions',
fileIncludePatterns: '*.zip',
fileExcludePatterns: '',
pushProperties: 'jenkins.server=Local\njenkins.reviewed=false',
pushDescription: 'Pushed from Jenkins',
pushIncremental: false
]
]
])
}
```
### Deploy Component
```groovy
node {
step([$class: 'UCDeployPublisher',
siteName: 'local',
deploy: [
$class: 'com.urbancode.jenkins.plugins.ucdeploy.DeployHelper$DeployBlock',
deployApp: 'Jenkins',
deployEnv: 'Test',
deployProc: 'Deploy Jenkins',
deployReqProps: 'AppProcessProp1=Value1\nAppProcessProp2=Value2',
createProcess: [
$class: 'com.urbancode.jenkins.plugins.ucdeploy.ProcessHelper$CreateProcessBlock',
processComponent: 'Deploy'
],
deployVersions: 'Jenkins:${BUILD_NUMBER}',
deployOnlyChanged: false
]
])
}
```
### Trigger Version Import
```groovy
node {
step([$class: 'UCDeployPublisher',
siteName: 'local',
component: [
$class: 'com.urbancode.jenkins.plugins.ucdeploy.VersionHelper$VersionBlock',
componentName: 'Jenkins',
createComponent: [
$class: 'com.urbancode.jenkins.plugins.ucdeploy.ComponentHelper$CreateComponentBlock',
componentTemplate: '',
componentApplication: 'Local'
],
delivery: [
$class: 'com.urbancode.jenkins.plugins.ucdeploy.DeliveryHelper$Pull',
pullProperties: 'FileSystemImportProperties/name=${BUILD_NUMBER}\nFileSystemImportProperties/description=Pushed from Jenkins',
pullSourceType: 'File System',
pullSourceProperties: 'FileSystemComponentProperties/basePath=C:\\Test',
pullIncremental: false
]
]
])
}
```
## Release Notes
### Version 2.3
Fixed APAR PI77548 - Component process properties failing to resolve on deployment.
### Version 2.2
Fixed RFE 98375 - Jenkins Plugin only allows Global credentials instead of job-based credentials.
Fixed PI75045 - UCD server maintenance mode check requires admin privileges.
### Version 2.1
Fixed PI61971 - Connection pool leak in Jenkins ibm-ucdeploy-build-steps.
### Older Versions
Fixed PI32899 - Jenkins plugin fails on slave nodes with an UnserializbleException
Fixed PI36005 - Jenkins plugin 1.2.1 not compatible with builds created with earlier versions of the plugin
Fixed PI37957 - Pulled in a fix for excludes options not being handled by a common library.