Skip to content

Commit 6e0807d

Browse files
Sample workflow (#2)
1 parent 4c69596 commit 6e0807d

File tree

3 files changed

+9
-3
lines changed

3 files changed

+9
-3
lines changed

.version

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
0.0.3
1+
0.0.4

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,15 @@ This is a simple GitHub Action that checks Golang codebases for potential Nil pa
99
Behind the hood, it uses Uber's [nilaway](https://github.com/qbaware/nilaway-action)
1010
static analysis tool.
1111
More useful information about it can be found in [this](https://www.uber.com/en-GB/blog/nilaway-practical-nil-panic-detection-for-go/)
12-
Uber blog post or on their GitHub [repo](https://github.com/uber-go/nilaway).
12+
Uber blog post or on their GitHub [repository](https://github.com/uber-go/nilaway).
1313

1414
## How To Use
1515

1616
### Figure Out The Inputs
1717

18-
As of now, the only input is the `package-to-scan` variable. This is the path to the Golang package you want to analyze. E.g. `./services/backend/...`.
18+
As of now, the only input is the `package-to-scan` variable.
19+
This is the path to the Golang package you want to analyze.
20+
E.g. `./services/backend/...`.
1921

2022
### Modify Your Action
2123

@@ -39,3 +41,7 @@ static-analysis:
3941
```
4042
4143
### That's It 🎉
44+
45+
### Sample Workflow
46+
47+
![sample-workflow](./resources/sample-workflow.png)

resources/sample-workflow.png

563 KB
Loading

0 commit comments

Comments
 (0)