Ghost can review source code changes for a variety of security issues, including injection vulnerabilities, business logic vulnerabilities, authorization issues, .
To enable Ghost code reviews for GitHub, an existing GitHub connection in the Ghost platform is required.Review ModeSet the Review Mode to control when Ghost will review code changes.
Review Mode
Description
Disabled
Code reviews will not run.
Auto
Code reviews will run automatically when a pull request is created, or when a draft PR is set to ready_for_review.
Manual
Code reviews will only run in response to slash command comments (e.g. /ghost review).
Minimum SeveritySet the Severity Threshold to control the minimum severity of findings that will be reported.
Threshold
Description
High
Only high severity issues will be reported.
Medium
Only medium and high severity issues will be reported.
Ghost code reviews are “comment” reviews rather than “approve” or “change request” reviews. This means Ghost code reviews do not count toward required approvals for the pull request. Final review decisions are made by a human reviewer on your team.
Full ReviewA full review of the code changes in the pull request.A full review will run automatically if Ghost Code Reviews are in auto mode.A full review can also be triggered manually with the /ghost review command if Ghost Code Reviews are in manual mode.Check ReviewA re-check of all issues from a full review. A check review will run automatically on pull request synchronize events if Ghost Code Reviews are in auto mode.During a check review, if an issue is no longer present in the code changes, it will be marked as “resolved”. A human reviewer is still required to sign off and resolve the review thread itself.A check review can also be triggered manually with the /ghost check command.Issue ReviewAn issue review is a review of a single issue from a full review.An issue review can be triggered manually with the /ghost issue <keywords> command.During an issue review, if the issue is no longer present in the code changes, it will be marked as “resolved”. A human reviewer is still required to sign off and resolve the review thread itself.
You can use slash commands to trigger several Ghost code review actions:
Command
Description
/ghost review
Perform a full review of the code changes.
/ghost check
Re-check issues from a full review (i.e. if there are code changes since the last review).
/ghost check <keywords>
Check a single issue from a full review (i.e. if there are code changes since the last review).
/ghost help
Show help for the /ghost command.
Triggering a full review with the /ghost review will mark all existing issues as “superseded”, then perform a full
review of the code changes in the current state.