Skip to content

Commit 15fd3e7

Browse files
committed
Adds 'Overview' section in README.md
1 parent ab94c5f commit 15fd3e7

File tree

4 files changed

+30
-16
lines changed

4 files changed

+30
-16
lines changed

README.md

Lines changed: 30 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,35 @@
11
# Integration Rust Cargo with GitHub Actions
22

3+
## Overview
4+
5+
### Error in code
6+
7+
![Error in code](doc/code_error.png)
8+
9+
### Failed test
10+
11+
![Failed test](doc/test_error.png)
12+
13+
### General result
14+
15+
![doc/result.png](doc/result.png)
16+
17+
## Inputs
18+
19+
- **Required** `command`: Cargo command like `build`, `check`, `test`, etc.
20+
- `args`: Arguments for the cargo command.
21+
- `manifest-path`: Path to the Cargo.toml. By default, is the working directory.
22+
- `token`: GitHub token. Used for enable more powerful annotation system. *Strongly recommended**
23+
- `toolchain`: Toolchain to use. For example: `nightly`.
24+
25+
_* 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`_
26+
27+
## Outputs
28+
29+
- `notice_count`: Notice count.
30+
- `warning_count`: Warning count.
31+
- `failure_count`: Failure count.
32+
333
## Example
434

535
```yaml
@@ -61,22 +91,6 @@ jobs:
6191
command: audit
6292
```
6393
64-
## Inputs
65-
66-
- **Required** `command`: Cargo command like `build`, `check`, `test`, etc.
67-
- `args`: Arguments for the cargo command.
68-
- `manifest-path`: Path to the Cargo.toml. By default, is the working directory.
69-
- `token`: GitHub token. Used for enable more powerful annotation system. *Strongly recommended**
70-
- `toolchain`: Toolchain to use. For example: `nightly`.
71-
72-
_* 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`_
73-
74-
## Outputs
75-
76-
- `notice_count`: Notice count.
77-
- `warning_count`: Warning count.
78-
- `failure_count`: Failure count.
79-
8094
## For developers
8195
8296
1. Install the dependencies.

doc/code_error.png

27.7 KB
Loading

doc/result.png

18.8 KB
Loading

doc/test_error.png

18.4 KB
Loading

0 commit comments

Comments
 (0)