Skip to content
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

devops improvement: Don't add command warning to standard output. #150

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

codebymikey
Copy link

@codebymikey codebymikey commented May 30, 2024

The Problem/Issue/Bug

When trying to run certain scripts, the warning added to the output is added directly to the standard output, and messes up the expected output.

How this PR Solves The Problem

It adds the notice to the standard output stream instead.

Ideally this notice should be behind an environment variable.

Manual Testing Instructions

php --version > /tmp/.php-version
# It shouldn't include the warning.
cat /tmp/.php-version

Related Issue Link(s)

Release/Deployment notes

Summary by CodeRabbit

  • Chores
    • Improved error handling in various script templates by redirecting echo command outputs to stderr.

Copy link

codesandbox bot commented May 30, 2024

Review or Edit in CodeSandbox

Open the branch in Web EditorVS CodeInsiders

Open Preview

Copy link
Contributor

coderabbitai bot commented May 30, 2024

Walkthrough

The changes involve modifying several shell script templates within the .gitpod/utils/script-templates/ directory. Specifically, the output of echo commands in these scripts is now redirected to stderr by adding >&2 before each echo statement. This ensures that messages are sent to the error stream, which can be useful for logging and debugging purposes.

Changes

Files Change Summary
.gitpod/utils/script-templates/ddev-composer.template.sh Redirect echo output to stderr by adding >&2 before echo.
.gitpod/utils/script-templates/ddev-drush.template.sh Redirect echo output to stderr by adding >&2 before echo.
.gitpod/utils/script-templates/ddev-node.template.sh Redirect echo output to stderr by adding >&2 before echo.
.gitpod/utils/script-templates/ddev-npx.template.sh Redirect echo output to stderr by adding >&2 before echo.
.gitpod/utils/script-templates/ddev-nvm.template.sh Redirect echo output to stderr by adding >&2 before echo.
.gitpod/utils/script-templates/ddev-php.template.sh Redirect echo output to stderr by adding >&2 before echo.
.gitpod/utils/script-templates/ddev-yarn.template.sh Redirect echo output to stderr by adding >&2 before echo.

Poem

In the land of code, where scripts reside,
Echoes now to stderr, they confide.
For debugging dreams and logs so clear,
These whispers to the error stream we steer.
A rabbit's touch, so gentle and wise,
Enhances our scripts, beneath coder skies.
🌟🐇✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 8ddc8c9 and be31052.

Files selected for processing (7)
  • .gitpod/utils/script-templates/ddev-composer.template.sh (1 hunks)
  • .gitpod/utils/script-templates/ddev-drush.template.sh (1 hunks)
  • .gitpod/utils/script-templates/ddev-node.template.sh (1 hunks)
  • .gitpod/utils/script-templates/ddev-npx.template.sh (1 hunks)
  • .gitpod/utils/script-templates/ddev-nvm.template.sh (1 hunks)
  • .gitpod/utils/script-templates/ddev-php.template.sh (1 hunks)
  • .gitpod/utils/script-templates/ddev-yarn.template.sh (1 hunks)
Files skipped from review due to trivial changes (7)
  • .gitpod/utils/script-templates/ddev-composer.template.sh
  • .gitpod/utils/script-templates/ddev-drush.template.sh
  • .gitpod/utils/script-templates/ddev-node.template.sh
  • .gitpod/utils/script-templates/ddev-npx.template.sh
  • .gitpod/utils/script-templates/ddev-nvm.template.sh
  • .gitpod/utils/script-templates/ddev-php.template.sh
  • .gitpod/utils/script-templates/ddev-yarn.template.sh

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant