Repository navigation
fix(action): read release outputs from a --output file, not scraped stdout #605
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
Merged
Merged
Changes from all commits
Commits
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,16 @@ | ||
| import { writeFileSync } from 'node:fs'; | ||
|
|
||
| /** | ||
| * Emit a command's JSON result. When `--output` is given, write it to that file — the reliable | ||
| * channel the GitHub Action reads, since stdout can be polluted by subprocess or log noise and a | ||
| * single stray byte breaks JSON parsing. Otherwise, when `--json` is set, print to stdout as before. | ||
| */ | ||
| export function emitResult(result: unknown, opts: { json?: boolean; output?: string }): void { | ||
| if (result === undefined || result === null) return; | ||
| const text = JSON.stringify(result, null, 2); | ||
| if (opts.output) { | ||
| writeFileSync(opts.output, text); | ||
| } else if (opts.json) { | ||
| console.log(text); | ||
| } | ||
| } |
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
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,48 @@ | ||
| import { mkdtempSync, readFileSync, rmSync } from 'node:fs'; | ||
| import { tmpdir } from 'node:os'; | ||
| import { join } from 'node:path'; | ||
| import { afterEach, describe, expect, it, vi } from 'vitest'; | ||
| import { emitResult } from '../../../src/commands/emitResult.js'; | ||
|
|
||
| describe('emitResult', () => { | ||
| const dirs: string[] = []; | ||
|
|
||
| afterEach(() => { | ||
| for (const dir of dirs) rmSync(dir, { recursive: true, force: true }); | ||
| dirs.length = 0; | ||
| vi.restoreAllMocks(); | ||
| }); | ||
|
|
||
| it('should write the JSON result to the output file when --output is set', () => { | ||
| const dir = mkdtempSync(join(tmpdir(), 'emit-result-')); | ||
| dirs.push(dir); | ||
| const file = join(dir, 'out.json'); | ||
| const log = vi.spyOn(console, 'log').mockImplementation(() => {}); | ||
|
|
||
| emitResult({ versionOutput: { tags: ['v1.2.3'] } }, { json: true, output: file }); | ||
|
|
||
| expect(JSON.parse(readFileSync(file, 'utf8'))).toEqual({ versionOutput: { tags: ['v1.2.3'] } }); | ||
| expect(log).not.toHaveBeenCalled(); | ||
| }); | ||
|
|
||
| it('should print to stdout when --json is set and no --output', () => { | ||
| const log = vi.spyOn(console, 'log').mockImplementation(() => {}); | ||
|
|
||
| emitResult({ a: 1 }, { json: true }); | ||
|
|
||
| expect(log).toHaveBeenCalledWith(JSON.stringify({ a: 1 }, null, 2)); | ||
| }); | ||
|
|
||
| it('should do nothing when neither --json nor --output is set', () => { | ||
| const log = vi.spyOn(console, 'log').mockImplementation(() => {}); | ||
| emitResult({ a: 1 }, {}); | ||
| expect(log).not.toHaveBeenCalled(); | ||
| }); | ||
|
|
||
| it('should do nothing for a null or undefined result', () => { | ||
| const log = vi.spyOn(console, 'log').mockImplementation(() => {}); | ||
| emitResult(undefined, { json: true }); | ||
| emitResult(null, { json: true }); | ||
| expect(log).not.toHaveBeenCalled(); | ||
| }); | ||
| }); |
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
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.
Uh oh!
There was an error while loading. Please reload this page.