jake
d26348d065
Reviewed-on: #1 Co-authored-by: jake <jake.young.dev@gmail.com> Co-committed-by: jake <jake.young.dev@gmail.com>
34 lines
1.4 KiB
Markdown
34 lines
1.4 KiB
Markdown
# donotpassgo
|
|
A composite workflow that runs general code checks on Go projects, an optional <b>test</b> input is available to trigger unit tests. See [steps](#steps) for more information on the jobs run
|
|
|
|
## Usage
|
|
adding donotpassgo to workflows is simple, just add the following step to your yaml file:
|
|
```yaml
|
|
- name: "checkpoint"
|
|
uses: https://code.jakeyoungdev.com/actions/donotpassgo@main
|
|
```
|
|
|
|
donotpassgo has optional support for running unit tests, this can be added by setting the <b>test</b> flag to <b>standard</b>
|
|
```yaml
|
|
- name: "checkpoint"
|
|
uses: https://code.jakeyoungdev.com/actions/donotpassgo@main
|
|
with:
|
|
test: standard
|
|
```
|
|
|
|
running unit tests with ginkgo is also supported by setting the <b>test</b> flag to <b>ginkgo</b>
|
|
```yaml
|
|
- name: "checkpoint"
|
|
uses: https://code.jakeyoungdev.com/actions/donotpassgo@main
|
|
with:
|
|
test: ginkgo
|
|
```
|
|
|
|
## Steps
|
|
donotpassgo runs several workflow jobs to ensure quality and secure go code, these steps may be updated as new tools develop.
|
|
### Dependency Scans
|
|
[govulncheck](https://pkg.go.dev/golang.org/x/vuln/cmd/govulncheck) is installed using golang and is used to scan for vulnerabilities in the project dependencies and standard library.
|
|
### Static Code Analysis
|
|
[gosec](https://github.com/securego/gosec) inspects source code for security problems
|
|
### Unit Tests
|
|
donotpassgo supports two unit tests libraries: the standard go library and [ginkgo](https://github.com/onsi/ginkgo) |