diff --git a/README.md b/README.md index 4909d10..b2fa040 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ This action enables you to run code analysis with Parasoft C/C++test Standard an Parasoft C/C++test uses a comprehensive set of analysis techniques, including pattern-based static analysis, dataflow analysis, metrics, code coverage, unit testing, and more, to help you verify code quality and ensure compliance with industry standards, such as MISRA, AUTOSAR, and CERT. - Request [a free trial](https://www.parasoft.com/products/parasoft-c-ctest/try/) to receive access to Parasoft C/C++test's features and capabilities. - - See the [user guide](https://docs.parasoft.com/display/CPPTEST20241) for information about Parasoft C/C++test's capabilities and usage. + - See the [user guide](https://docs.parasoft.com/display/CPPTEST20242) for information about Parasoft C/C++test's capabilities and usage. Please visit the [official Parasoft website](http://www.parasoft.com) for more information about Parasoft C/C++test and other Parasoft products. @@ -35,7 +35,7 @@ We recommend that you run Parasoft C/C++test on a self-hosted rather than GitHub ### Adding the Run C/C++test Action to a GitHub Workflow Add the `Run C/C++test` action to your workflow to launch code analysis with Parasoft C/C++test. -Depending on the project type and the build system you are using (Make, CMake, etc.), you may need to adjust the workflow to collect the required input data for C/C++test. See the [C/C++test User Guide](https://docs.parasoft.com/display/CPPTEST20241/Running+Static+Analysis+1) for details. +Depending on the project type and the build system you are using (Make, CMake, etc.), you may need to adjust the workflow to collect the required input data for C/C++test. See the [C/C++test User Guide](https://docs.parasoft.com/display/CPPTEST20242/Running+Static+Analysis+1) for details. ```yaml # Runs code analysis with C/C++test. @@ -227,7 +227,7 @@ jobs: ## Configuring Analysis with C/C++test You can configure analysis with Parasoft C/C++test in the following ways: - By customizing the `Run C/C++test` action directly in your GitHub workflow. See [Action Parameters](#action-parameters) for a complete list of available parameters. - - By configuring options in Parasoft C/C++test tool. We recommend creating a `cpptestcli.properties` file that includes all the configuration options and adding the file to C/C++test's working directory - typically, the root directory of your repository. This allows C/C++test to automatically read all the configuration options from that file. See [Parasoft C/C++test User Guide](https://docs.parasoft.com/display/CPPTEST20241/Configuration+1) for details. + - By configuring options in Parasoft C/C++test tool. We recommend creating a `cpptestcli.properties` file that includes all the configuration options and adding the file to C/C++test's working directory - typically, the root directory of your repository. This allows C/C++test to automatically read all the configuration options from that file. See [Parasoft C/C++test User Guide](https://docs.parasoft.com/display/CPPTEST20242/Configuration+1) for details. ### Examples This section includes practical examples of how the `Run C/C++test` action can be customized directly in the YAML file of your workflow. @@ -243,7 +243,7 @@ If `cpptestcli` executable is not on `$PATH`, you can configure the path to the ``` #### Defining the Scope of Analysis -You can configure the `input` parameter to provide the path to a file that defines the scope of analysis (includes a list of source files and compile commands). This parameter depends on the project type and the build system you are using. See the [C/C++test User Guide](https://docs.parasoft.com/display/CPPTEST20241/Running+Static+Analysis+1) for details. +You can configure the `input` parameter to provide the path to a file that defines the scope of analysis (includes a list of source files and compile commands). This parameter depends on the project type and the build system you are using. See the [C/C++test User Guide](https://docs.parasoft.com/display/CPPTEST20242/Running+Static+Analysis+1) for details. ```yaml - name: Run C/C++test uses: parasoft/run-cpptest-action@2.0.2 @@ -252,7 +252,7 @@ You can configure the `input` parameter to provide the path to a file that defin ``` #### Configuring a C/C++test Test Configuration -Code analysis with C/C++test is performed by using a test configuration - a set of static analysis rules that enforce best coding practices or compliance guidelines. Parasoft C/C++test ships with a wide range of [built-in test configurations](https://docs.parasoft.com/display/CPPTEST20241/Built-in+Test+Configurations). +Code analysis with C/C++test is performed by using a test configuration - a set of static analysis rules that enforce best coding practices or compliance guidelines. Parasoft C/C++test ships with a wide range of [built-in test configurations](https://docs.parasoft.com/display/CPPTEST20242/Built-in+Test+Configurations). To specify a test configuration directly in your workflow, add the `testConfig` parameter to the `Run C/C++test` action and specify the URL of the test configuration you want to use: ```yaml - name: Run C/C++test @@ -262,7 +262,7 @@ To specify a test configuration directly in your workflow, add the `testConfig` ``` #### Configuring a C/C++test Compiler Configuration -In order to run analysis, C/C++test needs to be configured for a specific compiler. You need to specify the configuration that matches your compiler with the `compilerConfig` parameter. See [Supported Compilers](https://docs.parasoft.com/display/CPPTEST20241/Supported+Compilers) for information about supported compilers. +In order to run analysis, C/C++test needs to be configured for a specific compiler. You need to specify the configuration that matches your compiler with the `compilerConfig` parameter. See [Supported Compilers](https://docs.parasoft.com/display/CPPTEST20242/Supported+Compilers) for information about supported compilers. ```yaml - name: Run C/C++test uses: parasoft/run-cpptest-action@2.0.2