Skip to content

Commit f5dcad4

Browse files
Merge pull request #393 from jenkinsci/other/Brand_images
Updated README.md with new content and logo (AST-99382)
2 parents 46135d5 + ee3c0c3 commit f5dcad4

File tree

1 file changed

+39
-16
lines changed

1 file changed

+39
-16
lines changed

README.md

Lines changed: 39 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<img src="https://raw.githubusercontent.com/Checkmarx/ci-cd-integrations/main/.images/banner.png">
1+
<img src="https://raw.githubusercontent.com/Checkmarx/ci-cd-integrations/main/.images/PluginBanner.jpg">
22
<br />
33
<div align="center">
44

@@ -13,7 +13,7 @@
1313
<br />
1414
<p align="center">
1515
<a href="https://github.com/jenkinsci/checkmarx-ast-scanner-plugin">
16-
<img src="https://raw.githubusercontent.com/Checkmarx/ci-cd-integrations/main/.images/logo.png" alt="Logo" width="80" height="80" />
16+
<img src="https://raw.githubusercontent.com/Checkmarx/ci-cd-integrations/main/.images/cx_x_icon.png" alt="Logo" width="80" height="80" />
1717
</a>
1818

1919
<h3 align="center">AST-JENKINS-PLUGIN </h3>
@@ -40,14 +40,15 @@
4040
<a href="#about-the-project">About The Project</a>
4141
</li>
4242
<li>
43-
<a href="#getting-started">Getting Started</a>
43+
<a href="#key-features">Key Features</a>
4444
<ul>
4545
<li><a href="#prerequisites">Prerequisites</a></li>
46-
<li><a href="#setting-up">Setting Up</a></li>
46+
<li><a href="#initial-setup">Initial Setup</a></li>
4747
</ul>
4848
</li>
4949
<li><a href="#usage">Usage</a></li>
50-
<li><a href="#contributing">Contributing</a></li>
50+
<li><a href="#contribution">Contribution</a></li>
51+
<li><a href="#feedback">Feedback</a></li>
5152
<li><a href="#license">License</a></li>
5253
<li><a href="#contact">Contact</a></li>
5354
</ol>
@@ -58,24 +59,44 @@
5859
<!-- ABOUT THE PROJECT -->
5960
## About The Project
6061

61-
The CxOne/CxAST Jenkins Plugin allows the user to trigger SAST, SCA and IaC and API Security scans directly from a Jenkins workflow.
62-
It provides a wrapper around the CxOne CLI Tool which creates a zip archive from your source code repository and uploads
63-
it to CxOne for scanning. The plugin provides easy integration into Jenkins while enabling scan customization using the
64-
full functionality and flexibility of the CLI tool.
62+
The Checkmarx One Jenkins plugin enables you to integrate the full functionality of the Checkmarx One platform into your Jenkins pipelines. You can use this plugin to trigger Checkmarx One scans as part of your CI/CD integration.
6563

66-
<!-- GETTING STARTED -->
67-
## Getting Started
64+
This plugin provides a wrapper around the [Checkmarx One CLI Tool](https://checkmarx.com/resource/documents/en/34965-68620-checkmarx-one-cli-tool.html) which creates a zip archive from your source code repository and uploads it to Checkmarx One for scanning. This provides easy integration with Jenkins while enabling scan customization using the full functionality and flexibility of the CLI tool.
6865

69-
The plugin can be configured as a build step within the Job Configuration.
66+
> The plugin code can be found [here](https://github.com/jenkinsci/checkmarx-ast-scanner-plugin/).
67+
68+
<!-- KEY FEATURES -->
69+
## Key Features
70+
71+
- Configure Jenkins pipelines to automatically trigger scans running all Checkmarx One scanners: CxSAST, CxSCA, IaC Security, Container Security, API Security, Secret Detection and Repository Health (OSSF Scorecard).
72+
- Supports integrating Checkmarx One build steps into FreeStyle or Pipeline projects
73+
- Supports use of CLI arguments to customize scan configuration, enabling you to:
74+
- Customize filters to specify which folders and files are scanned
75+
- Apply preset query configurations
76+
- Customize SCA scans using [SCA Resolver](https://checkmarx.com/resource/documents/en/34965-19196-checkmarx-sca-resolver.html)
77+
- Set thresholds to break build
78+
- Send requests via a proxy server
79+
- Break build upon policy violation
80+
81+
- View scan results summary and trends in the Jenkins environment
82+
- Direct links from within Jenkins to detailed Checkmarx One scan
83+
results
84+
- Generate customized scan reports in various formats (JSON, HTML, PDF
85+
etc.)
86+
- Generate SBOM reports (CycloneDX and SPDX)
87+
- Can be configured to automatically update to the latest CLI version
7088

7189
### Prerequisites
7290

73-
- A Jenkins installation v2.263.1 or above
91+
- A Jenkins installation LTS 2.263.1 or above (Supported Operating systems: Windows and Linux)
92+
93+
- You have a Checkmarx One account and you have an OAuth **Client ID** and **Client Secret** for that account. To create an OAuth client, see [Creating an OAuth Client for Checkmarx One Integrations](https://checkmarx.com/resource/documents/en/34965-118315-authentication-for-checkmarx-one-cli.html#UUID-a4e31a96-1f36-6293-e95a-97b4b9189060_UUID-4123a2ff-32d0-2287-8dd2-3c36947f675e).
7494

75-
- Access to a CxOne account (user credentials or an API Key)
95+
### Initial Setup
96+
- Verify that all prerequisites are in place.
7697

77-
### Setting Up
78-
To set the plugin up, follow this [Instructions](https://checkmarx.com/resource/documents/en/34965-68687-checkmarx-one-jenkins-plugin---installation-and-initial-setup.html)
98+
- Install the **Checkmarx AST Scanner** plugin and configure the
99+
settings as described [here](https://checkmarx.com/resource/documents/en/34965-68687-checkmarx-one-jenkins-plugin---installation-and-initial-setup.html).
79100

80101
## Usage
81102

@@ -88,6 +109,8 @@ To see how you can use our tool, please refer to the [Documentation](https://che
88109

89110
- Refer to our [contribution guidelines](https://github.com/jenkinsci/.github/blob/master/CONTRIBUTING.md)
90111

112+
## Feedback
113+
We’d love to hear your feedback! If you come across a bug or have a feature request, please let us know by submitting an issue in [GitHub Issues](https://github.com/jenkinsci/checkmarx-ast-scanner-plugin/issues).
91114

92115
<!-- LICENSE -->
93116
## License

0 commit comments

Comments
 (0)