fix: Add YAML document separator to each manifest #1928
Closed
Conversation
This file contains 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
rassie
force-pushed
the
multi-chart-stdout-separator
branch
from
fe7bf39
to
13a9d61
Compare
When output to STDOUT is requested, each manifest in an app is rendered separately and dumped to standard output. In case an app contains more than one chart, a document separator will be missing between adjacent charts, since there is no YAML document separator either at the beginning or at the end of an individual output. The last resource of the preceding chart and the first resource of the following chart will be merged into a random mess. By adding a YAML document separator after each manifest unconditionally, this can be cleanly avoided. Fixes: #943 Signed-off-by: Nikolai Prokoschenko <[email protected]>
rassie
force-pushed
the
multi-chart-stdout-separator
branch
from
13a9d61
to
5536128
Compare
rassie
changed the title
rassie
changed the title
iliapolo
requested changes
Sep 11, 2024
| @@ -94,6 +94,7 @@ class Command implements yargs.CommandModule { | |||
| const app = await synthApp(command, tempDir, stdout, recordConstructMetadata); | |||
| for (const f of app.manifests) { | |||
| fs.createReadStream(f).pipe(process.stdout); | |||
| process.stdout.write('---\n'); | |||
There was a problem hiding this comment.
This won't work as expected because the line just above it as asynchronous. It will print this before the manifests are printed. To do this we first need to await on the created pipeline:
import { pipeline } from 'stream';
import { promisify } from 'util';
const asyncPipeline = promisify(pipeline);
await asyncPipeline(fs.createReadStream(f), process.stdout, { end: false });
process.stdout.write('---\n');We should also have test to assert on the content of process.stdout using jest spies or something.
|
This PR has not received a response in a while and will be closed soon. If you want to keep it open, please leave a comment below @mentioning a maintainer. |
github-actions
bot
added
the
closing-soon
github-actions
bot
added
closed-for-staleness
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
When output to STDOUT is requested, each manifest in an app is rendered separately and dumped to standard output. In case an app contains more than one chart, a document separator will be missing between adjacent charts, since there is no YAML document separator either at the beginning or at the end of an individual output. The last resource of the preceding chart and the first resource of the following chart will be merged into a random mess. By adding a YAML document separator after each manifest unconditionally, this can be cleanly avoided.
Fixes: cdk8s-team/cdk8s#2155