docs: add exit code information #465
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This change documents the various exit codes in use for the `phylum-ci` script entry point. The documentation for integrations that make use of this script were updated to include a reference to the detail. The debug output now includes a link to that same detail. This change was generated from a user request. They were curious to know why a failing status check was reported when a successful analysis comment was added to their PR. They didn't understand what exit code 10 meant. This specific situation is already answered in a FAQ and now is more likely to be seen since it is referenced in the exit code table.
maxrake
changed the title
matt-phylum
previously approved these changes
Aug 26, 2024
matt-phylum
approved these changes
Aug 27, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change documents the various exit codes in use for the
phylum-ciscript entry point. The documentation for integrations that make use of this script were updated to include a reference to the detail. The debug output now includes a link to that same detail.This change was generated from a user request. They were curious to know why a failing status check was reported when a successful analysis comment was added to their PR. They didn't understand what exit code 10 meant. This specific situation is already answered in a FAQ and now is more likely to be seen since it is referenced in the exit code table.