Skip to content

Commit

Permalink
Created README
Browse files Browse the repository at this point in the history
  • Loading branch information
Nicholas Mathison committed Oct 16, 2017
1 parent 424ed84 commit c3f913e
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# IBM UrbanCode Deploy - Ansible Toolkit Plug-in
---
Note: This is not the plugin distributable! This is the source code. To find the installable plugin, go into the 'Releases' tab, and download a stable version.

### License
This plugin is protected under the [Eclipse Public 1.0 License](http://www.eclipse.org/legal/epl-v10.html)

### Compatibility
The IBM UrbanCode Deploy automation plugin uses Ansible's CLI.
This plug-in requires version 6.1.1 or later of IBM UrbanCode Deploy.

### Installation
The packaged zip is located in the releases folder. No special steps are required for installation. See Installing plug-ins in UrbanCode Deploy. Download this zip file if you wish to skip the manual build step. Otherwise, download the entire Ansible-Toolkit-UCD project and run the `gradle` command in the top level folder. This should compile the code and create a new distributable zip within the `build/distributions` folder. Use this command if you wish to make your own changes to the plugin.

### History
Version 53
- The Ansible Toolkit is now built through Gradle. All Ant and Ivy build pieces have been removed.
Version 52
- Community GitHub Release

### How to build the plugin from command line:

1. Navigate to the base folder of the project through command line.
2. Make sure that there is a build.gradle file in the root directory and execute the 'gradle' command.
3. The built plugin is located at `build/distributions/Ansible-Toolkit-UCD-vdev.zip`

0 comments on commit c3f913e

Please sign in to comment.