Skip to content

Commit aaeb0c2

Browse files
committed
Updated gradle-helpers version, updated README.md
1 parent e79e0e9 commit aaeb0c2

File tree

2 files changed

+50
-18
lines changed

2 files changed

+50
-18
lines changed

README.md

Lines changed: 49 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,34 @@
1+
<x-tag-head>
2+
<x-tag-meta http-equiv="X-UA-Compatible" content="IE=edge"/>
3+
4+
<x-tag-script language="JavaScript"><!--
5+
<X-INCLUDE url="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@10.0.0/build/highlight.min.js"/>
6+
--></x-tag-script>
7+
8+
<x-tag-script language="JavaScript"><!--
9+
<X-INCLUDE url="https://ajax.googleapis.com/ajax/libs/jquery/3.4.1/jquery.min.js" />
10+
--></x-tag-script>
11+
12+
<x-tag-script language="JavaScript"><!--
13+
<X-INCLUDE url="${gradleHelpersLocation}/spa_readme.js" />
14+
--></x-tag-script>
15+
16+
<x-tag-style><!--
17+
<X-INCLUDE url="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@10.0.0/build/styles/github.min.css" />
18+
--></x-tag-style>
19+
20+
<x-tag-style><!--
21+
<X-INCLUDE url="${gradleHelpersLocation}/spa_readme.css" />
22+
--></x-tag-style>
23+
</x-tag-head>
24+
125
# Fortify SSC Parser Plugin for OWASP Dependency Check
226

27+
## Introduction
28+
329
This Fortify SSC parser plugin allows for importing scan results from OWASP Dependency Check.
430

5-
### <a name="related-links">Related Links</a>
31+
### Related Links
632

733
* **Downloads**:
834
_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._
@@ -14,39 +40,40 @@ This Fortify SSC parser plugin allows for importing scan results from OWASP Depe
1440
* **OWASP Dependency Check website**: https://owasp.org/www-project-dependency-check/
1541

1642

17-
## <a name="usage">Usage</a>
43+
## Plugin Installation
1844

19-
The following sections describe how to install and use the plugin. For generic information
20-
about how to install and use SSC parser plugins, please see the Fortify SSC documentation.
45+
These sections describe how to install, upgrade and uninstall the plugin.
2146

22-
### <a name="plugin-install--upgrade">Plugin Install & Upgrade</a>
47+
### Install & Upgrade
2348

2449
* Obtain the plugin binary jar file
2550
* Either download from Bintray (see [Related Links](#related-links))
26-
* Or by building yourself (see [Information for plugin developers](#information-for-plugin-developers))
27-
* If you already have another version of the plugin installed, first uninstall the plugin by following the steps in [Plugin Uninstall](#plugin-uninstall)
51+
* Or by building yourself (see [Developers](#developers))
52+
* If you already have another version of the plugin installed, first uninstall the previously
53+
installed version of the plugin by following the steps under [Uninstall](#uninstall) below
2854
* In Fortify Software Security Center:
2955
* Navigate to Administration->Plugins->Parsers
3056
* Click the `NEW` button
3157
* Accept the warning
3258
* Upload the plugin jar file
3359
* Enable the plugin by clicking the `ENABLE` button
3460

35-
### <a name="plugin-uninstall">Plugin Uninstall</a>
61+
### Uninstall
3662

3763
* In Fortify Software Security Center:
3864
* Navigate to Administration->Plugins->Parsers
3965
* Select the parser plugin that you want to uninstall
4066
* Click the `DISABLE` button
4167
* Click the `REMOVE` button
4268

43-
### <a name="obtain-results">Obtain results</a>
69+
70+
## Obtain results
4471

4572
Please see the OWASP Dependency Check documentation for details on scanning applications and
4673
generating reports. Note that the SSC parser plugin requires the uploaded reports to be in JSON
4774
format.
4875

49-
### <a name="upload-results">Upload results</a>
76+
## Upload results
5077

5178
SSC web interface (manual upload):
5279

@@ -69,26 +96,26 @@ SSC clients (FortifyClient, Maven plugin, ...):
6996

7097

7198

72-
## <a name="information-for-plugin-developers">Information for plugin developers</a>
99+
## Developers
73100

74101
The following sections provide information that may be useful for developers of this
75102
parser plugin.
76103

77-
### <a name="ides">IDE's</a>
104+
### IDE's
78105

79106
This project uses Lombok. In order to have your IDE compile this project without errors,
80107
you may need to add Lombok support to your IDE. Please see https://projectlombok.org/setup/overview
81108
for more information.
82109

83-
### <a name="gradle">Gradle</a>
110+
### Gradle Wrapper
84111

85112
It is strongly recommended to build this project using the included Gradle Wrapper
86113
scripts; using other Gradle versions may result in build errors and other issues.
87114

88115
The Gradle build uses various helper scripts from https://github.com/fortify-ps/gradle-helpers;
89116
please refer to the documentation and comments in included scripts for more information.
90117

91-
### <a name="commonly-used-commands">Commonly used commands</a>
118+
### Common Commands
92119

93120
All commands listed below use Linux/bash notation; adjust accordingly if you
94121
are running on a different platform. All commands are to be executed from
@@ -108,7 +135,7 @@ the main project directory.
108135
Note that the version management tasks operate only on the local repository; you will need to manually
109136
push any changes (including tags and branches) to the remote repository.
110137

111-
### <a name="versioning">Versioning</a>
138+
### Versioning
112139

113140
The various version-related Gradle tasks assume the following versioning methodology:
114141

@@ -118,7 +145,7 @@ The various version-related Gradle tasks assume the following versioning methodo
118145
* However, note that the Gradle build may be unable to identify a correct version number for the project
119146
* As such, only builds from tagged versions or from a `<version>-SNAPSHOT` branch should be published to a Maven repository
120147

121-
### <a name="automated-builds--publishing">Automated Builds & publishing</a>
148+
### CI/CD
122149

123150
Travis-CI builds are automatically triggered when there is any change in the project repository,
124151
for example due to pushing changes, or creating tags or branches. If applicable, binaries and related
@@ -131,6 +158,11 @@ artifacts are automatically published to Bintray using the `bintrayUpload` task:
131158
See the [Related Links](#related-links) section for the relevant Travis-CI and Bintray links.
132159

133160

134-
# <a name="licensing">Licensing</a>
161+
## License
162+
<x-insert text="<!--"/>
163+
135164
See [LICENSE.TXT](LICENSE.TXT)
136165

166+
<x-insert text="-->"/>
167+
168+
<x-include url="file:LICENSE.TXT"/>

build.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ plugins {
99
group 'com.fortify.ssc.parser.owasp.dependencycheck'
1010

1111
ext {
12-
gradleHelpersLocation = "https://raw.githubusercontent.com/fortify-ps/gradle-helpers/1.0"
12+
gradleHelpersLocation = "https://raw.githubusercontent.com/fortify-ps/gradle-helpers/1.1"
1313
}
1414

1515
apply from: "${gradleHelpersLocation}/repo-helper.gradle"

0 commit comments

Comments
 (0)