Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions bin/github.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
import { relative, resolve, sep } from 'node:path'

// Path used for the GitHub `::error file=` annotation. GitHub resolves it from the repo root
// (GITHUB_WORKSPACE), but under lerna/nx the cwd is the package dir, so a cwd-relative path won't
// map onto the PR diff. Anchor to GITHUB_WORKSPACE in CI so the annotation lands on the right file.
// GitHub matches annotation paths with POSIX separators, so emit forward slashes even on Windows
// runners (where node:path would otherwise produce backslashes that never match the repo file).
export const resolveAnnotationFile = (rawFile, { cwd, CI, GITHUB_WORKSPACE }) => {
const absolute = resolve(cwd, rawFile)
const base = CI && GITHUB_WORKSPACE ? GITHUB_WORKSPACE : cwd
return relative(base, absolute).split(sep).join('/')
}
8 changes: 7 additions & 1 deletion bin/reporter.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import { relative, resolve, normalize } from 'node:path'
import { spec as SpecReporter } from 'node:test/reporters'
import { fileURLToPath } from 'node:url'
import { color, haveColors, dim } from './color.js'
import { resolveAnnotationFile } from './github.js'

const { CI, GITHUB_WORKSPACE, LERNA_PACKAGE_NAME } = process.env

Expand Down Expand Up @@ -159,7 +160,12 @@ export default async function nodeTestReporterExodus(source) {
if (path.length > 0) assert(path.pop() === data.name) // afterAll can generate failures too, with an empty path
if (!data.todo) failedFiles.add(file)
if (!notPrintedError(data.details.error)) {
const { body, loc } = extractError(data, relative(cwd, data.file || data.name)) // might be different from current file if in subimport
const errorFile = resolveAnnotationFile(data.file || data.name, {
cwd,
CI,
GITHUB_WORKSPACE,
})
const { body, loc } = extractError(data, errorFile) // might be different from current file if in subimport
if (!data.todo && CI && loc.line != null && loc.col != null) {
print(`::error ${serializeGitHub(Object.entries(loc))}::${escapeGitHub(body)}`)
} else if (body) {
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@
"bin/electron.js",
"bin/electron.preload.cjs",
"bin/find-binary.js",
"bin/github.js",
"bin/inband.js",
"bin/reporter.js",
"loader/babel.cjs",
Expand Down
31 changes: 31 additions & 0 deletions tests/github.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
import { test } from 'node:test'
import assert from 'node:assert/strict'
import { resolveAnnotationFile } from '../bin/github.js'

// GitHub resolves `::error file=...` annotation paths from the repo root (GITHUB_WORKSPACE).
// lerna/nx run each package with cwd = the package dir, so a cwd-relative path points at the wrong
// place and the annotation never lands on the PR diff. In CI the path must be workspace-relative.
const GITHUB_WORKSPACE = '/home/runner/work/repo/repo'
const cwd = `${GITHUB_WORKSPACE}/packages/foo` // what lerna/nx hands the reporter
const absFile = `${cwd}/src/bar.test.js`

test('CI annotation path is repo-root-relative so it lands on the PR diff', () => {
const file = resolveAnnotationFile(absFile, { cwd, CI: '1', GITHUB_WORKSPACE })
assert.equal(file, 'packages/foo/src/bar.test.js')
})

test('a relative input is resolved against cwd before anchoring to the workspace', () => {
const file = resolveAnnotationFile('src/bar.test.js', { cwd, CI: '1', GITHUB_WORKSPACE })
assert.equal(file, 'packages/foo/src/bar.test.js')
})

test('outside CI the path stays cwd-relative (local runs are unchanged)', () => {
assert.equal(
resolveAnnotationFile(absFile, { cwd, CI: undefined, GITHUB_WORKSPACE }),
'src/bar.test.js'
)
assert.equal(
resolveAnnotationFile(absFile, { cwd, CI: '1', GITHUB_WORKSPACE: undefined }),
'src/bar.test.js'
)
})
Loading