readme update

This commit is contained in:
2026-04-03 16:07:28 -04:00
parent 46528033ed
commit 5d04db9a89

View File

@@ -1,9 +1,13 @@
# donotpassgo # donotpassgo
donotpassgo is a github/gitea action to run standard go checks in pipelines. donotpassgo is a github/gitea action to run unit tests and standards/security checks for Go applications
## TODO ## Inputs
explain inputs in readme |Input|Required|Values|Default|Description|
test |-----|-----|-----|-----|-----|
does file naming matter here if the project has install.sh or /src will we overwrite? |test-library|false|standard,ginkgo,none|none|unit testing library to use, tests are skipped if set to 'none'|
review MR, im drunk-ish |test-version|false|any ginkgo version|latest|the version of the testing library to use (only ginkgo supported atm, value is ignored if using standard lib testing)|
some jobs need env vars still lol |test-fail|false|yes,no|yes|does the job fail if unit tests fail|
|static|false|yes,no|yes|do static code checks run|
|static-fail|false|yes,no|yes|does the job fail if static code checks fail|
|vulnerability|false|yes,no|yes|do dependencies get scanned for vulnerabilities|
|vulnerability-fail|false|yes,no|yes|does the job fail if vulnerabilities are found|