|
1 | 1 | # UTBotJava-action
|
2 | 2 |
|
3 |
| -An action for unit tests generation and SARIF report creation with the [UTBotJava](https://github.com/UnitTestBot/UTBotJava) engine. |
| 3 | +You want to reduce extra moves and save some time in your working process. We have an action for that! |
4 | 4 |
|
5 |
| -The action imports the SARIF output into GitHub. The SARIF output displays errors in the Security Code Scanning Alerts section. |
| 5 | +See: now you can initiate unit tests generation and SARIF report creation right into GitHub with the [UTBotJava](https://github.com/UnitTestBot/UTBotJava) engine. |
6 | 6 |
|
7 |
| -## Content |
| 7 | +The action imports the SARIF output into your GitHub repository and creates the Security Code Scanning Alerts section, where you can find all code errors displayed. |
8 | 8 |
|
9 |
| -- [Usage](#usage) |
| 9 | +Sounds pretty cool, and it really is! 😃 |
| 10 | + |
| 11 | + |
| 12 | +- [How to use](#how-to-use) |
10 | 13 | - [Inputs](#inputs)
|
11 | 14 | - [Manual trigger](#manual-trigger-configuration)
|
12 | 15 |
|
13 |
| -## Usage |
| 16 | +## How to use |
14 | 17 |
|
15 |
| -1. Apply the [UTBot gradle plugin](https://plugins.gradle.org/plugin/org.utbot.gradle.plugin) to your project. |
16 |
| -2. Create the workflow with UTBotJava-action. Simple workflow example: |
| 18 | +1. Start with applying the [UTBot gradle plugin](https://plugins.gradle.org/plugin/org.utbot.gradle.plugin) to your project. |
| 19 | +2. Then, create the workflow with UTBotJava-action. Simple workflow example: |
17 | 20 |
|
18 | 21 | ```YAML
|
19 | 22 | name: "Run UTBotJava-action"
|
@@ -41,10 +44,12 @@ jobs:
|
41 | 44 | - name: Run UTBotJava-action
|
42 | 45 | uses: UnitTestBot/UTBotJava-action@main
|
43 | 46 | ```
|
44 |
| -3. Look at the Security Code Scanning Alerts to see the detected errors. |
| 47 | +3. Check the Security Code Scanning Alerts to see the detected errors. |
45 | 48 |
|
46 | 49 | ## Inputs
|
47 | 50 |
|
| 51 | +Here are the input data parameters for the UTBotJava-action: |
| 52 | +
|
48 | 53 | | Name | Description | Options | Default value |
|
49 | 54 | | --- | --- | --- | --- |
|
50 | 55 | | `pushTests` | Push generated tests to the repository or not | - | true |
|
|
60 | 65 |
|
61 | 66 | __Workflow example:__
|
62 | 67 |
|
63 |
| -Please note that in this case, GitHub displays errors in the Pull Request Checks section. |
| 68 | +📍 __Important note__: in this case, GitHub displays errors in the Pull Request Checks section. |
64 | 69 |
|
65 | 70 | ```YAML
|
66 | 71 | name: "Run UTBotJava-action"
|
@@ -105,10 +110,8 @@ jobs:
|
105 | 110 |
|
106 | 111 | ## Manual trigger configuration
|
107 | 112 |
|
108 |
| -You can create a workflow that are manually triggered with the `workflow_dispatch` event. |
109 |
| - |
110 |
| -You will then see a __Run workflow__ button on the Actions tab, enabling you to easily trigger a run. |
111 |
| - |
112 |
| -Step-by-step instruction on how to configure a manual workflow can be found in the [example repository](https://github.com/UnitTestBot/UTBotJava-action-example). |
| 113 | +Apart from the automatic action, you can also create a workflow with a __Run workflow__ button that will let you launch the action manually. Like this: |
113 | 114 |
|
114 | 115 | 
|
| 116 | + |
| 117 | +How to do this? Find a step-by-step instruction in the [example repository](https://github.com/UnitTestBot/UTBotJava-action-example). 😉 |
0 commit comments