Skip to content

Glossary

Documentation Index

Fetch the complete documentation index at: https://docs.sourcery.ai/llms.txt

Use this file to discover all available pages before exploring further.

Terms Sourcery uses across these docs, defined in one place. Each entry links to the page where you can read more.

TermDefinition
AdminManages the plan, billing, seats, and account settings. You’re an admin if you’re an admin of your GitHub organization or GitLab group, or an explicit Sourcery admin. Roles
AutocreateOpens a Jira task automatically when a scan reports a security finding, gated by a severity threshold, per-type toggles, and a daily cap. Connect Jira
DeeplinkA URL that opens a supported editor straight on the Sourcery extension, used for one-click installs. Install the extension
FindingA single security issue found by one of Sourcery’s scanners, with a severity score, a status, and membership in a group. Security findings
GroupFindings that look alike, shown as one row in the issues view. Turn grouping off to see every finding on its own. Security findings
IgnorePermanently marks a finding as not needing action. Available for a single finding, a path prefix, or a rule. Triage
MemberUses Sourcery (reviews, IDE, dashboard) but can’t change the plan, billing, or seats. Roles
Review ruleA check you write in plain language, scoped to file paths, that Sourcery applies on every review. Review rules
Reviewer’s guideA review comment that maps the change set file by file, so human reviewers know where to focus. Anatomy of a review
Risk profileA per-repository setting (network exposure and data sensitivity) that Sourcery uses to weight finding severities for that repo. Repository risk profile
ScanA security scan run over a repository’s default branch. Sourcery’s scanners run and report their findings to the dashboard. The scanners
SeatAn allocation of Sourcery access to one person, covering code reviews, the IDE extension, and the dashboard. Seats and team
Severity overrideAdjusts a finding’s severity when the scored level isn’t how you’d rank it. Remove the override to restore the original score. Triage
SnoozeSets a finding aside until a date you choose, with an optional reason. Future scans still detect the issue. Triage
Status checkThe single “Sourcery review” check on the pull request’s head commit, reporting the review’s outcome. Anatomy of a review
SummaryA summary of the pull request’s purpose and risk, written into the description under a “Summary by Sourcery” heading. Anatomy of a review