Skip to main content

GitHub Actions - Changelog

The following table lists the features and changes that have been implemented for GitHub Actions with the relevant version release.

Plugin Version

Release Date

CLI Version

Improvements

Bug Fixes

2.0.34

Sep 20, 2024

2.2.5

  • General improvements and bug fixes

2.0.33

Aug 13, 2024

2.2.3

  • Fixed problem with generating SBOM reports.

2.0.32

Aug 9, 2024

2.2.2

  • General improvements and bug fixes

2.0.31

Jul 21, 2024

2.2.1

  • General improvements and bug fixes

2.0.30

July 16, 2024

2.2.0

  • General improvements and bug fixes

2.0.29

June 23, 2024

2.1.5

  • General improvements and bug fixes

2.0.28

May 19, 2024

2.1.2

  • The CLI that this plugin is based on is now signed with the Checkmarx digital signature, indicating that this is an official Checkmarx product. This enables communication from this plugin to bypass firewalls on Windows computers that previously blocked the unsigned CLI.

2.0.27

May 15, 2024

2.1.1

  • General improvements and bug fixes.

2.0.26

May 8, 2024

2.1.0

  • We have improved the precision of the exit codes in order to give a more clear picture of which particular scanners failed. We have also created a new CLI command, results exit-code, for retrieving information about the completion status for a particular scan in Checkmarx One, as well as details about failures of specific scan engines.

    Caution

    For users who are using external commands (e.g., $LastExitCode for Powershell) to obtain exit codes for the scan create command, this is a breaking change. You need to refactor your pipelines based on the new exit codes, which are shown here.

2.0.25

Apr 16,2024

2.0.74

  • Improved the content and graphic presentation of the PDF scan report generated using --report-format pdf in the additional_params. Learn about the improved scan report here.

2.0.24

Apr 9, 2024

2.0.72

  • Added a new flag, --sast-fast-scan to the additional_params, for running SAST scans in fast scan mode.

  • Added a new flag --application-name to the additional_params, which enables users to assign the project to a specific application.

    Note: This is only effective when creating a new project and assigning it to an existing application.

  • Added Directory.Packages.props to the list of included files (when creating the zip archive for scanning).

  • Added policy violations to PR/MR decorations.

2.0.23

Feb 5, 2024

2.0.66

  • Fixed issue that sarif output had been failing when there were no SAST results.

2.0.22

Jan 17, 2024

2.0.64

  • The output log is now stored to a variable cxcli, enabling users to access this data further along in their pipeline.

  • Made the summary HTML report responsive in order to improve display on narrow screens.

  • Fixed issue that submitting --groups was interfering with project configuration (e.g., removing designation of primary branch).

  • Fixed issue that sarif reports had been failing when no vulnerabilities were identified.

2.0.21

Oct 10, 2023

2.0.58

  • Updated CLI code to GO version 1.21.1 in order to remediate a vulnerability.

  • We now return an unlimited number of results in the results summary (had been limited to 10k).

  • Added an environment variable, "CX_IGNORE_PROXY", for ignoring proxies. Mark the variable as true to ensure that all Checkmarx One CLI commands run directly from the local machine.

  • Added Podfile and Podfile.lock to the list of included files (when creating the zip archive for scanning).

2.0.20

July 28, 2023

2.0.53

  • Added information about violated policies to the scan summary output.

    For policies that are configured to "break build", when the policy is violated the scan will fail. (The --ignore-policy flag can be applied using --additional-params to prevent policies from causing the scan to fail).

2.0.19

June 30, 2023

2.0.50

  • Added the ability to generate SBOM reports. SBOMs can be generated using CycloneDX or SPDX format. SPDX reports are output in JSON format, and CycloneDX can be output as JSON or xml. This can be done using the scan create or results show command.

  • Increased the default limit for projects returned using the project list command to 10,000. (This enables Checkmarx One to effectively verify whether a project with the specified name already exists when a scan is initiated via CLI/plugin.)

  • We added a new environment variable, CX_HTTP_PROXY, which can be used to designate a specialized proxy for Checkmarx One. When this is used, it overrides the proxy specified in your general HTTP_PROXY variable.

    Notice

    We still support use of the HTTP_PROXY variable if you choose to use the same proxy for Checkmarx One as for your other applications.

2.0.18

Apr 3, 2023

2.0.44

  • You can now designate a scan as a "Private Package" and assign a package version to it using the addtional_params options. Once a private package has been scanned, info about the risks affecting that package will be identified by SCA when that package version is used in any of your projects. You can download an article about private packages here.

  • We added the --sca-exploitable-path flag to the additional_params options. This enables you to designate whether or not Exploitable Path will run on this particular scan. When used, this overrides the designation made in the project settings.

    We also added a flag --sca-last-sast-scan-time, which enables you to specify the number of days that SAST scan results are considered valid for use in Exploitable Path (i.e., if there is no current SAST scan, how many days prior to the current SCA scan will Checkmarx One look for a SAST scan to use for analyzing Exploitable Path.)

    Warning

    The --sca-last-sast-scan-time flag is not yet fully supported and may not function as designed.

  • Improved memory usage when uploading zip files.

  • Added file extensions go.mod, go.sum, *.dart, and *.plist to the list of included files (when creating the zip archive for scanning).

2.0.17

Feb 23, 2023

2.0.42

  • The scan results summary is now shown in the build summary section on the build page.

  • Added option to generate reports in PDF format by setting --report-format to pdf. For PDF format reports, you can add the following additional flags:

    • Add the --report-pdf-email flag to specify email recipients.

    • Add the --report-pdf-options flag to specify which sections to include in the report. Options are: Iac-Security, Sast,Sca, ScanSummary, ExecutiveSummary, ScanResults.

2.0.16

Feb 2, 2023

2.0.41

General improvements and bug fixes.

2.0.15

Jan 27, 2023

2.0.40

  • Added option to generate reports in PDF format.

2.0.14

Jan 20, 2023

2.0.39

  • All references to AST have been changed to use the new product name "Checkmarx One".

  • Fixed issue that the Checkmarx GitHub action had been using an API that was deprecated by GitHub.

2.0.13

Dec 7, 2022

2.0.37

  • The KICS scanner is now referred to in Checkmarx One as "IaC Security". All mentions of the scanner and the vulnerabilities identified by it, now refer to IaC Security.

  • The API Security scanner is now supported for use via the CLI. When running the scan create command, you can now add api_security to the list of scanners under --scan-types.

2.0.12

Nov 10, 2022

2.0.34

  • The scan ID is now given as an output of the step, so that it can be used to obtain data from the scan for use in subsequent steps.

2.0.11

Sep 21, 2022

2.0.29

  • General improvements and bug fixes

2.0.10

Sep 15, 2022

2.0.28

  • General improvements and bug fixes

2.0.9

Sep 2, 2022

2.0.27

  • Added a Job Summary with the scan ID to the GitHub Action.

  • The comments for pull requests are now decorated with results from Checkmarx One scans that were triggered by that pull request. The comments show a list of new vulnerabilities introduced by the code change as well as the vulnerabilities that were fixed.

  • All documentation links now point to the new Checkmarx documentation portal at https://checkmarx.com/resource/documentation.

Fixes issue that summary wasn't working when checkmarx link is a secret.

2.0.8

Aug 1, 2022

2.0.23

  • General improvements and bug fixes

2.0.7

Jul 5, 2022

2.0.20

  • General improvements and bug fixes

2.0.6

Jun 15, 2022

2.0.19

  • General improvements and bug fixes

2.0.5

Jun 2, 2022

2.0.18

  • You can now add filters to the scan create command (to exclude files/folders from the scan) separately for each specific scanner. The flags for the new filters are: --sast-filter <string>, --kics-filter <string>, --sca-filter <string>. See scan create.

    Tip

    The existing flag --file-filter , which sets filters for the entire scan (for all scanners) is still in use.

  • You can now add an ssh key to a scan, using the flag --ssh-key <string> with the path to the ssh private key.

Fixed issue that the branch specified in the settings was not overriding the pull request branch. The pull request branch is now used as the default when no branch is specified.

2.0.4

Apr 12, 2022

2.0.16

General improvements and bug fixes

2.0.3

Mar 2, 2022

2.0.13

  • Added new --sca-resolver-params flag to the scan create command. See documentation here.

  • The branch name is now shown correctly for Pull requests.

2.0.2

Feb 11, 2022

2.0.12

  • In the scan create command, we renamed the format flag as scan-info-format.

  • Renamed the results command as results show command.

  • Fixed a problem with proxy connections.

  • An error is now generated when project name is empty.

2.0.1

Jan 26, 2022

2.0.10

  • Added SummaryJSON reports.

  • Added the --scan-timeout <int> flag to the scan create command, enabling users to specify a time limit after which the scan will fail and terminate. See documentation here.

  • Updated UI elements to reflect the new Checkmarx branding (e.g., logo).

2.0.0

Jan 11, 2022

2.0.9

  • Added ability to break builds by specifying a threshold for acceptable vulnerabilities.

  • Added support for exporting scan results directly to SonarQube or SonarCloud console. See documentation here.

2.0.29

Nov 3, 2021

2.0.4

  • Updated CLI to version 2.0.4

  • Added branch parameter (required)

2.0.19

  • Added tenant support to CLI

  • Added tenant support to Github action and Jenkins

2.0.18

  • Added tenant support.

  • Updated the sources parameter:

    • Removed archive_source and source _directory.

    • Support only -s option

  • Fixed bug with additional parameters and spaces.

  • Fixed Preset – Not mandatory anymore.

2.0.17

  • Updated documentation:

    • Using scan_types instead of project_types

2.0.15

  • Supports SAST Scans.

  • Defines required and non-required parameters.

  • Provide examples for demos.