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

Add a bit of debug context #1032

Merged

Conversation

theodore-s-beers
Copy link
Contributor

@theodore-s-beers theodore-s-beers commented Nov 4, 2024

I think it could be helpful to know at this point that what is being printed is the exit code of the preceding curl command. It should be 0, of course, but we saw another value (60) while troubleshooting an issue with an endpoint. It took me a while to figure out what it was referring to.

Summary by Sourcery

Enhancements:

  • Add context to debug output by specifying that the printed value is the curl command's exit code.

Copy link

sourcery-ai bot commented Nov 4, 2024

Reviewer's Guide by Sourcery

The change adds more descriptive debug output in a shell script by clarifying that a printed value represents a curl command's exit code. This improves troubleshooting by making the debug output more self-explanatory.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Enhanced debug output clarity in shell script
  • Modified echo statement to explicitly indicate the value being printed is a curl exit code
repository/docker/entrypoint_authz.sh

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @theodore-s-beers - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@JoshuaSBrown
Copy link
Collaborator

@theodore-s-beers, thanks for creating the PR. We should probably work to wrap all the print statements behind a debug flag at some point but this is an improvement.

@JoshuaSBrown JoshuaSBrown merged commit 0d5060e into ORNL:release_June_2024 Nov 4, 2024
1 check passed
@theodore-s-beers
Copy link
Contributor Author

@JoshuaSBrown, should I add an entry to the changelog?

@theodore-s-beers theodore-s-beers deleted the release_June_2024 branch November 22, 2024 22:14
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.

2 participants