Updates to build process

Author: rsenden

README.md

@@ -6,9 +6,9 @@ This Fortify SSC parser plugin allows for importing scan results from OWASP Depe
 
 * **Downloads**:  
   _Beta versions may be unstable or non-functional. The `*-licenseReport.zip` and `*-dependencySources.zip` files are for informational purposes only and do not need to be downloaded._
-  * **Release versions**: https://bintray.com/package/files/fortify-ps/binaries/fortify-ssc-parser-owasp-dependency-check-release?order=desc&sort=fileLastModified&basePath=&tab=files  
-  * **Beta versions**: https://bintray.com/package/files/fortify-ps/binaries/fortify-ssc-parser-owasp-dependency-check-beta?order=desc&sort=fileLastModified&basePath=&tab=files
-  * **Sample input files**: [src/test/resources](src/test/resources)
+	* **Release versions**: https://bintray.com/package/files/fortify-ps/binaries/fortify-ssc-parser-owasp-dependency-check-release?order=desc&sort=fileLastModified&basePath=&tab=files  
+	* **Beta versions**: https://bintray.com/package/files/fortify-ps/binaries/fortify-ssc-parser-owasp-dependency-check-beta?order=desc&sort=fileLastModified&basePath=&tab=files
+	* **Sample input files**: [src/test/resources](src/test/resources)
 * **Automated builds**: https://travis-ci.com/fortify-ps/fortify-ssc-parser-owasp-dependency-check
 * **OWASP Dependency Check website**: https://owasp.org/www-project-dependency-check/
 
@@ -21,23 +21,23 @@ about how to install and use SSC parser plugins, please see the Fortify SSC docu
 ### Plugin Install & Upgrade
 
 * Obtain the plugin binary jar file
-  * Either download from Bintray (see [Related Links](#related-links)) 
-  * Or by building yourself (see [Information for plugin developers](#information-for-plugin-developers))
+	* Either download from Bintray (see [Related Links](#related-links)) 
+	* Or by building yourself (see [Information for plugin developers](#information-for-plugin-developers))
 * If you already have another version of the plugin installed, first uninstall the plugin by following the steps in [Plugin Uninstall](#plugin-uninstall)
 * In Fortify Software Security Center:
-  * Navigate to Administration->Plugins->Parsers
-  * Click the `NEW` button
-  * Accept the warning
-  * Upload the plugin jar file
-  * Enable the plugin by clicking the `ENABLE` button
+	* Navigate to Administration->Plugins->Parsers
+	* Click the `NEW` button
+	* Accept the warning
+	* Upload the plugin jar file
+	* Enable the plugin by clicking the `ENABLE` button
 
 ### Plugin Uninstall
 
 * In Fortify Software Security Center:
-  * Navigate to Administration->Plugins->Parsers
-  * Select the parser plugin that you want to uninstall
-  * Click the `DISABLE` button
-  * Click the `REMOVE` button 
+	* Navigate to Administration->Plugins->Parsers
+	* Select the parser plugin that you want to uninstall
+	* Click the `DISABLE` button
+	* Click the `REMOVE` button 
 
 ### Obtain results
 
@@ -60,11 +60,11 @@ SSC clients (FortifyClient, Maven plugin, ...):
 * Generate a scan.info file containing a single line as follows:  
   `engineType=OWASP_DEPCHECK`
 * Generate a zip file containing the following:
-  * The scan.info file generated in the previous step
-  * The JSON file containing scan results
+	* The scan.info file generated in the previous step
+	* The JSON file containing scan results
 * Upload the zip file generated in the previous step to SSC
-  * Using any SSC client, for example FortifyClient
-  * Similar to how you would upload an FPR file
+	* Using any SSC client, for example FortifyClient
+	* Similar to how you would upload an FPR file
 
 
 
@@ -95,13 +95,13 @@ the main project directory.
 
 * `./gradlew tasks --all`: List all available tasks
 * Build: (plugin binary will be stored in `build/libs`)
-  * `./gradlew clean build`: Clean and build the project
-  * `./gradlew build`: Build the project without cleaning
-  * `./gradlew dist`: Build distribution zip
+	* `./gradlew clean build`: Clean and build the project
+	* `./gradlew build`: Build the project without cleaning
+	* `./gradlew dist`: Build distribution zip
 * Version management:
-  * `./gradlew printProjectVersion`: Print the current version
-  * `./gradlew startSnapshotBranch -PnextVersion=2.0`: Start a new snapshot branch for an upcoming `2.0` version
-  * `./gradlew releaseSnapshot`: Merge the changes from the current branch to the master branch, and create release tag
+	* `./gradlew printProjectVersion`: Print the current version
+	* `./gradlew startSnapshotBranch -PnextVersion=2.0`: Start a new snapshot branch for an upcoming `2.0` version
+	* `./gradlew releaseSnapshot`: Merge the changes from the current branch to the master branch, and create release tag
 * `./fortify-scan.sh`: Run a Fortify scan; requires Fortify SCA to be installed
 
 Note that the version management tasks operate only on the local repository; you will need to manually
@@ -114,8 +114,8 @@ The various version-related Gradle tasks assume the following versioning methodo
 * The `master` branch is only used for creating tagged release versions
 * A branch named `<version>-SNAPSHOT` contains the current snapshot state for the upcoming release
 * Optionally, other branches can be used to develop individual features, perform bug fixes, ...
-  * However, note that the Gradle build may be unable to identify a correct version number for the project
-  * As such, only builds from tagged versions or from a `<version>-SNAPSHOT` branch should be published to a Maven repository
+	* However, note that the Gradle build may be unable to identify a correct version number for the project
+	* As such, only builds from tagged versions or from a `<version>-SNAPSHOT` branch should be published to a Maven repository
 
 ### Automated Builds & publishing
 

build.gradle

@@ -3,6 +3,7 @@ plugins {
   id "com.jfrog.bintray" version "1.8.4"
   id 'org.ajoberstar.grgit' version "4.0.0"
   id 'com.github.jk1.dependency-license-report' version '1.12'
+  id "org.kordamp.gradle.markdown" version "2.0.0"
 }
 
 group 'com.fortify.ssc.parser.owasp.dependencycheck'
@@ -29,6 +30,7 @@ ext {
 apply from: "${gradleHelpersLocation}/ssc-parser-plugin-helper.gradle"
 apply from: "${gradleHelpersLocation}/dependency-sources-licenses-helper.gradle"
 apply from: "${gradleHelpersLocation}/bintray-binaries-helper.gradle"
+apply from: "${gradleHelpersLocation}/readme2html.gradle"
 
 apply plugin: 'java'
 sourceCompatibility = 1.8
@@ -43,18 +45,18 @@ dependencies {
 }
 
 task dist(type: Zip) {
-	dependsOn 'build'
+	dependsOn 'build', 'readme2html'
 	archiveFileName = "${rootProject.name}-${project.version}.zip"
 	destinationDirectory = file("$buildDir/dist")
 	from("${libsDir}") {
 		include "${rootProject.name}-${project.version}.jar"
 	}
+	from "${buildDir}/html"
 	from("${projectDir}/src/test/resources") {
 		into 'sampleData'
 	}
 	from("${projectDir}") {
 		include "LICENSE.TXT"
-		include "README.md"
 	}
 }