Theme Push: Change progress bar writestream to stderr #3765
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
|
Thanks for your contribution! Depending on what you are working on, you may want to request a review from a Shopify team:
|
Coverage report
Show new covered files 🐣
Show files with reduced coverage 🔻
Test suite run success1659 tests passing in 769 suites. Report generated by 🧪jest coverage report action from ea177a1 |
jamesmengo
changed the title
jamesmengo
changed the title
This comment has been minimized.
This comment has been minimized.
jamesmengo
force-pushed
the
jmeng/renderTaskstoStdErr
branch
from
db6e33c to
b9090a9
Compare
jamesmengo
force-pushed
the
jmeng/renderTaskstoStdErr
branch
from
b9090a9 to
ea177a1
Compare
jamesmengo
commented
Apr 24, 2024
| if (tasks.length > 0) { | ||
| await renderTasks(tasks, {renderOptions: {stdout: process.stderr}}) | ||
| } | ||
| } |
There was a problem hiding this comment.
Not sure where the best place to put this is - since many of our commands in the themes space are used in CI, we should probably use this by default rather than renderTasks
There was a problem hiding this comment.
I personally believe this should be the default options on CLI kit, but it's ok to restrict the scope of the change for now :)
charlespwd
approved these changes
Apr 29, 2024
karreiro
approved these changes
Apr 30, 2024
Merged
5 tasks
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.
WHY are these changes introduced?
Addresses some of the issues raised in
theme push#3734I think the DX for CI users could use some attention when resourcing allows (output logging, troubleshooting tips when flags are missing, etc)
For future contributors: I'm following Command Line Interface Guidelines here
WHAT is this pull request doing?
stderrThe Ink library used by CLI-kit writes this to
stdoutby default - this is causing the stream to get polluted, breaking operations such asshopify theme push --json | jq .Risk: If someone is reading the values of
stderrwe may have just introduced a problem there instead. An alternative would be to write to a silent writestream instead - Example HereHow to test your changes?
Try running
pnpm shopify theme push --path <theme_path> --json | jq .pnpm shopify theme push --path <theme_path> --json 1> stdout.txt 2> stderr.rtxtNote: Don't test with the
--verboseflag -outputDebugwrites everythingstdout(for now). This will have to be addressed separately if it gets changedMeasuring impact
How do we know this change was effective? Please choose one:
Checklist
devordeployhave been reflected in the internal flowchart.