Skip to content

Commit 572ff91

Browse files
Forward GitHub Check name metadata [ship] (#1397)
* feat: forward GitHub check name metadata * feat: forward GitHub reporting context metadata * feat: clarify GitHub check name metadata
1 parent b367bdb commit 572ff91

3 files changed

Lines changed: 24 additions & 0 deletions

File tree

packages/cli/src/rest/__tests__/test-sessions.spec.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ describe('TestSessions REST client', () => {
77
commitId: 'abc123',
88
github: {
99
reporting: true,
10+
source: 'checkly-action',
11+
githubCheckName: 'Checkly PR code checks',
12+
pullRequestNumber: '5',
13+
environmentUrl: 'https://preview.example.com',
1014
repository: 'checkly/playwright-reporter-demo',
1115
sha: 'abc123',
1216
runId: '123456',

packages/cli/src/services/__tests__/util.spec.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ const ENV_KEYS = [
1212
'CHECKLY_REPO_URL',
1313
'CHECKLY_REPO_BRANCH',
1414
'CHECKLY_GITHUB_REPORT',
15+
'CHECKLY_GITHUB_SOURCE',
16+
'CHECKLY_GITHUB_CHECK_NAME',
17+
'CHECKLY_GITHUB_PULL_REQUEST_NUMBER',
18+
'CHECKLY_GITHUB_ENVIRONMENT_URL',
1519
'CHECKLY_GITHUB_REPOSITORY',
1620
'CHECKLY_GITHUB_SHA',
1721
'CHECKLY_GITHUB_RUN_ID',
@@ -95,6 +99,10 @@ describe('util', () => {
9599

96100
it('should include GitHub Actions metadata when Checkly GitHub reporting is enabled', () => {
97101
process.env.CHECKLY_GITHUB_REPORT = 'true'
102+
process.env.CHECKLY_GITHUB_SOURCE = 'checkly-action'
103+
process.env.CHECKLY_GITHUB_CHECK_NAME = 'Checkly PR code checks'
104+
process.env.CHECKLY_GITHUB_PULL_REQUEST_NUMBER = '5'
105+
process.env.CHECKLY_GITHUB_ENVIRONMENT_URL = 'https://preview.example.com'
98106
process.env.CHECKLY_GITHUB_REPOSITORY = 'checkly/playwright-reporter-demo'
99107
process.env.CHECKLY_GITHUB_SHA = 'abc123def456'
100108
process.env.CHECKLY_GITHUB_RUN_ID = '123456'
@@ -112,6 +120,10 @@ describe('util', () => {
112120
repoUrl: 'https://github.com/checkly/playwright-reporter-demo',
113121
github: {
114122
reporting: true,
123+
source: 'checkly-action',
124+
githubCheckName: 'Checkly PR code checks',
125+
pullRequestNumber: '5',
126+
environmentUrl: 'https://preview.example.com',
115127
repository: 'checkly/playwright-reporter-demo',
116128
sha: 'abc123def456',
117129
runId: '123456',

packages/cli/src/services/util.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ export interface GitInformation {
2020

2121
export interface GitHubActionsInformation {
2222
reporting: true
23+
source?: string
24+
githubCheckName?: string
25+
pullRequestNumber?: string
26+
environmentUrl?: string
2327
repository?: string
2428
sha?: string
2529
runId?: string
@@ -149,6 +153,10 @@ export function getGitInformation (repoUrl?: string): GitInformation | null {
149153
if (isGitHubReportingEnabled()) {
150154
gitInformation.github = {
151155
reporting: true,
156+
source: process.env.CHECKLY_GITHUB_SOURCE,
157+
githubCheckName: process.env.CHECKLY_GITHUB_CHECK_NAME,
158+
pullRequestNumber: process.env.CHECKLY_GITHUB_PULL_REQUEST_NUMBER,
159+
environmentUrl: process.env.CHECKLY_GITHUB_ENVIRONMENT_URL,
152160
repository: process.env.CHECKLY_GITHUB_REPOSITORY,
153161
sha: process.env.CHECKLY_GITHUB_SHA,
154162
runId: process.env.CHECKLY_GITHUB_RUN_ID,

0 commit comments

Comments
 (0)