FairwindsOps/pluto

Exit code documentation mismatch between advanced.md docs and output.go code.

kabam-zmohamad opened this issue · 1 comments

In pluto/docs/advanced.md, there are only 3 exit codes shown, but in pluto/pkg/api/output.go, there are 4+1 exit codes possible.

  • 0: If no deprecations/removal are found
  • 1: Error code, this shouldn't ever be outputted unless something goes horribly wrong
  • 2: Deprecation found
  • 3: Removal found, with replacement available
  • 4: Removal found, with no replacement available.

Would it be possible to update the documentation to reflect this? Also would it be possible to provide an example on how to use the exit codes in other Github Action steps/workflows as well?

I believe the last code was added after the documentation was written and needs to be updated. Would you be willing to contribute that fix?