diff --git a/.version b/.version index 6812f81..05b19b1 100644 --- a/.version +++ b/.version @@ -1 +1 @@ -0.0.3 \ No newline at end of file +0.0.4 \ No newline at end of file diff --git a/README.md b/README.md index a2837d6..e261d8a 100644 --- a/README.md +++ b/README.md @@ -9,13 +9,15 @@ This is a simple GitHub Action that checks Golang codebases for potential Nil pa Behind the hood, it uses Uber's [nilaway](https://github.com/qbaware/nilaway-action) static analysis tool. More useful information about it can be found in [this](https://www.uber.com/en-GB/blog/nilaway-practical-nil-panic-detection-for-go/) -Uber blog post or on their GitHub [repo](https://github.com/uber-go/nilaway). +Uber blog post or on their GitHub [repository](https://github.com/uber-go/nilaway). ## How To Use ### Figure Out The Inputs -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/...`. +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/...`. ### Modify Your Action @@ -39,3 +41,7 @@ static-analysis: ``` ### That's It 🎉 + +### Sample Workflow + +![sample-workflow](./resources/sample-workflow.png) diff --git a/resources/sample-workflow.png b/resources/sample-workflow.png new file mode 100644 index 0000000..8c26305 Binary files /dev/null and b/resources/sample-workflow.png differ