Skip to content

Commit c87e4b2

Browse files
authored
Update README.md
1 parent 23d4d5f commit c87e4b2

File tree

1 file changed

+17
-14
lines changed

1 file changed

+17
-14
lines changed

README.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
11
# UTBotJava-action
22

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!
44

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.
66

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.
88

9-
- [Usage](#usage)
9+
Sounds pretty cool, and it really is! 😃
10+
11+
12+
- [How to use](#how-to-use)
1013
- [Inputs](#inputs)
1114
- [Manual trigger](#manual-trigger-configuration)
1215

13-
## Usage
16+
## How to use
1417

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:
1720

1821
```YAML
1922
name: "Run UTBotJava-action"
@@ -41,10 +44,12 @@ jobs:
4144
- name: Run UTBotJava-action
4245
uses: UnitTestBot/UTBotJava-action@main
4346
```
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.
4548
4649
## Inputs
4750
51+
Here are the input data parameters for the UTBotJava-action:
52+
4853
| Name | Description | Options | Default value |
4954
| --- | --- | --- | --- |
5055
| `pushTests` | Push generated tests to the repository or not | - | true |
@@ -60,7 +65,7 @@ jobs:
6065

6166
__Workflow example:__
6267

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.
6469

6570
```YAML
6671
name: "Run UTBotJava-action"
@@ -105,10 +110,8 @@ jobs:
105110

106111
## Manual trigger configuration
107112

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:
113114

114115
![image](https://user-images.githubusercontent.com/54814796/176915768-e89bf101-56e6-4303-8b77-485c7ecb5143.png)
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

Comments
 (0)