ci: Add a new option `silentLogs` for cleaner CI/build output by RulaKhaled · Pull Request #2563 · getsentry/sentry-cli

RulaKhaled · 2025-06-20T10:43:37Z

This PR introduces a new silentLogs option that provides a middle ground between full verbose output and complete silence. When enabled, it suppresses verbose command output while still displaying essential feedback like success messages and error information.

const cli = new SentryCli('config', { silentLogs: true });
await cli.releases.new('v1.0.0');
// Output: "✓ Release v1.0.0 created"

await cli.sourcemaps.upload();  
// Output: "✓ Source maps uploaded"

szokeasaurusrex

Generally seems okay, did have a few minor suggestions though (and also want to be sure that this is non-breaking)

szokeasaurusrex · 2025-06-23T11:57:53Z

js/helper.js

+      } else if (args[1] === 'finalize' && args[2]) {
+        return `✓ Release ${args[2]} finalized`;
+      } else if (args[1] === 'files' && args[3] === 'upload-sourcemaps' && args[2]) {
+        return `✓ Source maps uploaded to release ${args[2]}`;


[nit] We should align the output here with the output for sourcemaps upload (note that sentry-cli releases files upload-sourcemaps is deprecated). Either both should include the release (if present), or likely simpler is just to remove the output from both.

szokeasaurusrex · 2025-06-23T12:00:07Z

js/helper.js

+    case 'upload-dif':
+      return `✓ Debug information files uploaded`;
+
+    case 'upload-dsym':
+      return `✓ dSYM files uploaded`;


These commands are both deprecated aliases of debug-files upload, so output should be the same

Suggested change

case 'upload-dif':

return `✓ Debug information files uploaded`;

case 'upload-dsym':

return `✓ dSYM files uploaded`;

case 'upload-dif':

case 'upload-dsym':

return `✓ Debug files uploaded`;

szokeasaurusrex · 2025-06-23T12:01:09Z

js/helper.js

+    case 'mobile-app':
+      if (args[1] === 'upload') {
+        return `✓ Mobile app uploaded`;
+      }
+      break;


Let's not add this yet, this command is still a work in progress.

Suggested change

case 'mobile-app':

if (args[1] === 'upload') {

return `✓ Mobile app uploaded`;

}

break;

szokeasaurusrex · 2025-06-23T12:03:23Z

js/helper.js

+    case 'send-metric':
+      return `✓ Metric sent`;


Maybe not necessary to add this either, as metrics are deprecated, and will be rejected if users attempt to send them to Sentry SaaS

Suggested change

case 'send-metric':

return `✓ Metric sent`;

szokeasaurusrex · 2025-06-23T12:04:39Z

js/helper.js

+ * Determines an appropriate success message based on the command.
+ *
+ * @param {string[]} args Command line arguments passed to sentry-cli
+ * @returns {string|null} Success message to display or null if no message needed


Maybe it is preferable to type this just as string, using empty string instead of null? Not sure how we typically do it in JS, so I'll defer to you on this.

Suggested change

* @returns {string|null} Success message to display or null if no message needed

* @returns {string} Success message to display or empty string if no message needed

Returning null expresses that "there is no success message to show" rather than "the success message is empty".
It is more consistent with JavaScript best practices for optional values.

szokeasaurusrex · 2025-06-23T12:08:03Z

js/helper.js

 * @returns {Promise.<string>} A promise that resolves to the standard output.
 */
-async function execute(args, live, silent, configFile, config = {}) {
+async function execute(args, live, silent, silentLogs, configFile, config = {}) {


Is this part of public API?

I think users should only use the execute method provided by the SentryCli class

cursor · 2025-08-07T13:23:30Z

js/helper.js

+      } else if (silentLogs && live !== 'rejectOnError') {
+        // Capture stdout to filter it, but show stderr for errors
+        // Not applicable for rejectOnError mode which needs to capture output
+        stdio = ['ignore', 'pipe', 'inherit'];


Bug: Sentry CLI Hangs on Unread Piped Output

When silentLogs is true and live is true (but not 'rejectOnError'), the sentry-cli child process's stdout is configured as 'pipe' but is never read by the parent process. This can cause the child process to block or hang if it produces substantial output that fills the pipe buffer. The piped stdout should either be drained or the stdio option for stdout should be set to 'ignore'.

szokeasaurusrex · 2025-09-12T13:36:07Z

@RulaKhaled I am currently doing a clean-up of stale draft PRs in the repo.

Are you still working on this change? Would you like help to complete it?

If not, please close the PR 🙏

RulaKhaled changed the title ~~ci: Add a new option for cleaner CI/build output~~ ci: Add a new option silentLogs for cleaner CI/build output Jun 20, 2025

RulaKhaled marked this pull request as ready for review June 23, 2025 11:34

RulaKhaled requested a review from szokeasaurusrex as a code owner June 23, 2025 11:34

szokeasaurusrex reviewed Jun 23, 2025

View reviewed changes

RulaKhaled added 2 commits August 7, 2025 14:49

ci: Add a new option for cleaner CI/build output

a7fd171

refactor tests

4e33b73

RulaKhaled force-pushed the new-silentLogs-command branch from d26527b to 4e33b73 Compare August 7, 2025 13:19

RulaKhaled requested a review from a team as a code owner August 7, 2025 13:19

RulaKhaled requested a review from sl0thentr0py August 7, 2025 13:19

cursor bot reviewed Aug 7, 2025

View reviewed changes

RulaKhaled marked this pull request as draft August 7, 2025 14:09

szokeasaurusrex removed the request for review from sl0thentr0py September 12, 2025 13:36

RulaKhaled closed this Sep 16, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

ci: Add a new option `silentLogs` for cleaner CI/build output#2563

ci: Add a new option `silentLogs` for cleaner CI/build output#2563
RulaKhaled wants to merge 2 commits intomasterfrom
new-silentLogs-command

RulaKhaled commented Jun 20, 2025

Uh oh!

szokeasaurusrex left a comment

Uh oh!

szokeasaurusrex Jun 23, 2025

Uh oh!

szokeasaurusrex Jun 23, 2025

Uh oh!

szokeasaurusrex Jun 23, 2025

Uh oh!

szokeasaurusrex Jun 23, 2025

Uh oh!

szokeasaurusrex Jun 23, 2025

Uh oh!

RulaKhaled Aug 7, 2025

Uh oh!

szokeasaurusrex Jun 23, 2025 •

edited

Loading

Uh oh!

RulaKhaled Aug 7, 2025

Uh oh!

cursor bot Aug 7, 2025

Uh oh!

szokeasaurusrex commented Sep 12, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	* @returns {string\|null} Success message to display or null if no message needed
	* @returns {string} Success message to display or empty string if no message needed

Uh oh!

Conversation

RulaKhaled commented Jun 20, 2025

Uh oh!

szokeasaurusrex left a comment

Choose a reason for hiding this comment

Uh oh!

szokeasaurusrex Jun 23, 2025

Choose a reason for hiding this comment

Uh oh!

szokeasaurusrex Jun 23, 2025

Choose a reason for hiding this comment

Uh oh!

szokeasaurusrex Jun 23, 2025

Choose a reason for hiding this comment

Uh oh!

szokeasaurusrex Jun 23, 2025

Choose a reason for hiding this comment

Uh oh!

szokeasaurusrex Jun 23, 2025

Choose a reason for hiding this comment

Uh oh!

RulaKhaled Aug 7, 2025

Choose a reason for hiding this comment

Uh oh!

szokeasaurusrex Jun 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RulaKhaled Aug 7, 2025

Choose a reason for hiding this comment

Uh oh!

cursor bot Aug 7, 2025

Choose a reason for hiding this comment

Bug: Sentry CLI Hangs on Unread Piped Output

Uh oh!

szokeasaurusrex commented Sep 12, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

szokeasaurusrex Jun 23, 2025 •

edited

Loading