-
Notifications
You must be signed in to change notification settings - Fork 1
fix: anchor GitHub annotation path to GITHUB_WORKSPACE #60
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
exo-mv
wants to merge
2
commits into
main
Choose a base branch
from
fix/reporter-annotation-workspace-path
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+51
−1
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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('/') | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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' | ||
| ) | ||
| }) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: camel case function params/object properties