Analysis Run
A Run
is an analysis done against your codebase.
run
Query: run
fetch the details of a single run using either the runUid
identifier or commitOid
.
Arguments
Sample Request
query {
run(runUid:"0613332b-436a-429b-95e3-6e01d72208b3") {
id
createdAt
branchName
baseOid
finishedAt
}
}
or,
query {
run(commitOid:"6df7f08b029abbf25905abf1bc79fde72934045b") {
id
createdAt
branchName
baseOid
finishedAt
}
}
Sample Response
{
"data": {
"run": {
"id": "QW5hbHlzaXNadW46eHpkZ3Zi",
"createdAt": "2019-01-07T20:52:19.491314+00:00",
"branchName": "foobar",
"finishedAt": "2019-01-07T20:52:34.677357+00:00"
}
}
}
Objects
AnalysisRun
Field | Type | Description |
---|---|---|
createdAt | DateTime! | The time at which the Run was created. |
branchName | String | The branch name against which the analysis was run. |
baseOid | String | The commit ID which acts as the root for the Analysis. All issues introduced in the code before this commit are ignored by DeepSource. |
commitOid | String | The commit ID on which the Analysis is run. |
finishedAt | DateTime | The time at which the Run completed. |
repository | Repository! | The repository on which the Analysis has run. |
id | ID! | The ID of the object. |
runUid | UUID! | UID of this AnalysisRun. |
status | AnalysisRunStatus! | The current status of the run. |
summary | AnalysisRunSummary! | Summary of the analysis run. |
changesetStats | ChangesetStats | Statistics pertaining to the changeset (of a commit or PR) in the analysis run. |
updatedAt | DateTime! | Time when the analysis run was last modified. |
checks | CheckConnection! | Analyzer checks in the analysis run. |
offset | Int | |
before | String | |
after | String | |
first | Int | |
last | Int |
AnalysisRunConnection
Field | Type | Description |
---|---|---|
pageInfo | PageInfo! | Pagination data for this connection. |
edges | [AnalysisRunEdge]! | Contains the nodes in this connection. |
totalCount | Int | The total number of analysis runs in the connection. |
AnalysisRunEdge
A Relay edge containing a AnalysisRun
and its cursor.
Field | Type | Description |
---|---|---|
node | AnalysisRun | The item at the end of the edge. |
cursor | String! | A cursor for use in pagination. |
AnalysisRunSummary
Field | Type | Description |
---|---|---|
occurrencesIntroduced | Int | Number of issues introduced during this analysis run, between the `baseOid` and the `commitOid` |
occurrencesResolved | Int | Number of issues marked as resolved in this analysis run |
occurrencesSuppressed | Int | Number of issues marked as suppressed in this analysis run. |
occurrenceDistributionByAnalyzer | OccurrenceDistributionByAnalyzer | Number of issues raised per analyzer. |
occurrenceDistributionByCategory | [OccurrenceDistributionByCategory] | Number of issues raised per issue category. |
OccurrenceDistributionByAnalyzer
OccurrenceDistributionByCategory
Field | Type | Description |
---|---|---|
category | IssueCategory! | Category of the issue. |
introduced | Int! | Number of issues detected that belong to this category. |
ChangesetStats
Statistics pertaining to the changeset (of a commit or PR), as analyzed by an AnalysisRun
.
Field | Type | Description |
---|---|---|
lines | ChangesetStatsCounts! | Stats for number of lines in the changeset. |
branches | ChangesetStatsCounts! | Stats for number of branches in the changeset. |
conditions | ChangesetStatsCounts! | Stats for number of conditions in the changeset. |
ChangesetStatsCounts
Overall and newly added number of lines (or branches or conditions) in a changeset. Note: 0
depicts no lines (or branches or conditions) were found whereas None
depicts the information is not available.
Field | Type | Description |
---|---|---|
overall | Int | Overall number of lines (or branches or conditions) across the repository. |
overallCovered | Int | Overall number of lines (or branches or conditions) that are covered across the repository. |
new | Int | Newly added number of lines (or branches or conditions) in the changeset. |
newCovered | Int | Newly added number of lines (or branches or conditions) that are covered in the changeset. |
Updated 8 months ago