Output schema
Output schema
This page is generated from the Go types the report files are encoded from, so it always matches the actual output.
Every report file holds one RepoActivity object. Fields marked as optional are left out of the file when they are empty.
RepoActivity
| Field | Type | Optional |
|---|---|---|
repo | string | no |
repo_url | string | no |
owner | string | no |
name | string | no |
start | timestamp (RFC 3339) | no |
end | timestamp (RFC 3339) | no |
generated_at | timestamp (RFC 3339) | no |
prs_authored | array of PullRequestActivity | yes |
prs_reviewed | array of PullRequestReviewActivity | yes |
issues_created | array of IssueActivity | yes |
issues_commented | array of IssueActivity | yes |
mentions | array of MentionActivity | yes |
maintainer_new_issues | array of IssueActivity | yes |
releases | array of ReleaseActivity | yes |
tags | array of TagActivity | yes |
PullRequestActivity
| Field | Type | Optional |
|---|---|---|
number | integer | no |
title | string | no |
url | string | no |
status | string | no |
author | string | no |
merged_by | string | yes |
reviewers | array of string | yes |
description | string | no |
additions | integer | no |
deletions | integer | no |
changed_files | integer | no |
comments | array of Comment | yes |
reviews | array of Review | yes |
created_at | timestamp (RFC 3339) | no |
updated_at | timestamp (RFC 3339) | no |
merged_at | timestamp (RFC 3339) | yes |
PullRequestReviewActivity
| Field | Type | Optional |
|---|---|---|
number | integer | no |
title | string | no |
url | string | no |
status | string | no |
author | string | no |
user_reviews | array of Review | yes |
all_reviews | array of Review | yes |
created_at | timestamp (RFC 3339) | no |
updated_at | timestamp (RFC 3339) | no |
IssueActivity
| Field | Type | Optional |
|---|---|---|
number | integer | no |
title | string | no |
url | string | no |
author | string | no |
body | string | no |
reactions | integer | no |
comments | array of Comment | yes |
created_at | timestamp (RFC 3339) | no |
updated_at | timestamp (RFC 3339) | no |
MentionActivity
| Field | Type | Optional |
|---|---|---|
title | string | no |
url | string | no |
author | string | no |
body | string | no |
created_at | timestamp (RFC 3339) | no |
source | string | no |
ReleaseActivity
| Field | Type | Optional |
|---|---|---|
title | string | no |
url | string | no |
tag_name | string | no |
body | string | no |
business_value | string | no |
created_at | timestamp (RFC 3339) | no |
published_at | timestamp (RFC 3339) | no |
draft | boolean | no |
prerelease | boolean | no |
TagActivity
| Field | Type | Optional |
|---|---|---|
title | string | no |
url | string | no |
name | string | no |
commit_sha | string | no |
created_at | timestamp (RFC 3339) | no |
Comment
| Field | Type | Optional |
|---|---|---|
id | integer | no |
author | string | no |
body | string | no |
url | string | no |
type | string | no |
created_at | timestamp (RFC 3339) | no |
Review
| Field | Type | Optional |
|---|---|---|
id | integer | no |
author | string | no |
body | string | no |
url | string | no |
state | string | no |
submitted_at | timestamp (RFC 3339) | no |