Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
qRoC authored Sep 26, 2024
1 parent eed2ac2 commit 4a9827f
Showing 1 changed file with 32 additions and 20 deletions.
52 changes: 32 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,27 @@
# Integration Rust Cargo with GitHub Actions

## Overview

### Error in code

![Error in code](doc/code_error.png)

### Failed test

![Failed test](doc/test_error.png)

### General result

![doc/result.png](doc/result.png)

## Inputs
## Integration Rust Cargo with GitHub Actions

### Overview

<table>
<tr>
<td rowspan=2 width=45% align=center>
<h5>General result</h5>
<img src="doc/result.png" alt="General result">
</td>
<td>
<h5>Error in code</h5>
<img src="doc/code_error.png" alt="Error in code">
</td>
</tr>
<tr>
<td>
<h5>Failed test</h5>
<img src="doc/test_error.png" alt="Failed test">
</td>
</tr>
</table>

### Inputs

- **Required** `command`: Cargo command like `build`, `check`, `test`, etc.
- `args`: Arguments for the cargo command.
Expand All @@ -24,15 +31,20 @@

_* Default GitHub Actions annotations supports only up to 10 warnings and 10 errors for per the step. With `token` you up this limit to `1000`_

## Outputs
### Outputs

- `notice_count`: Notice count.
- `warning_count`: Warning count.
- `failure_count`: Failure count.

## Example
### Example

```yaml

# if `with.token` is used
permissions:
checks: write

jobs:
build:
runs-on: ubuntu-latest
Expand Down Expand Up @@ -91,7 +103,7 @@ jobs:
command: audit
```
## For developers
### For developers
1. Install the dependencies.
Expand Down

0 comments on commit 4a9827f

Please sign in to comment.