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

refactor(version): skip extra info if empty #18438

Merged
merged 1 commit into from
Nov 10, 2023
Merged

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Nov 10, 2023

Description

Follow-up of #18063.
Noticed while backporting it to v0.50 that empty extra info would always be marshalled as null. This PR fixes that and only display extra info if present.

This PR will be cherry-picked in #18437


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • run make lint and make test
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

Summary by CodeRabbit

  • Refactor
    • Simplified the handling of extra information in the version command, improving code readability and efficiency.
    • Modified the data type of the ExtraInfo field in the Info struct for better data management.

@julienrbrt julienrbrt requested a review from a team as a code owner November 10, 2023 10:35
Copy link
Contributor

coderabbitai bot commented Nov 10, 2023

Walkthrough

Walkthrough

The overall change involves a simplification of the codebase by eliminating the use of pointers for the ExtraInfo field in the Info struct. This change affects both the version/command.go and version/version.go files, where the ExtraInfo field is directly assigned and accessed, respectively, without the need for pointers.

Changes

File Path Change Summary
version/command.go Simplified the code by directly assigning the result of extraInfoFromContext to verInfo.ExtraInfo instead of using a pointer.
version/version.go Modified the Info struct, changing the type of ExtraInfo field from a pointer to a non-pointer type. This affects how ExtraInfo is handled and accessed within the Info struct.

Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai help to get help.
  • @coderabbitai resolve to resolve all the CodeRabbit review comments.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 7208905 and f23d76f.
Files selected for processing (2)
  • version/command.go (1 hunks)
  • version/version.go (1 hunks)
Files skipped from review due to trivial changes (1)
  • version/command.go
Additional comments: 1
version/version.go (1)
  • 71-74: The change from a pointer to a non-pointer type for ExtraInfo in the Info struct is a good move for simplicity and safety. It eliminates the need to check for nil before accessing ExtraInfo. However, ensure that all usages of ExtraInfo in the codebase are updated to reflect this change.

@julienrbrt julienrbrt added this pull request to the merge queue Nov 10, 2023
Merged via the queue into main with commit 79c6418 Nov 10, 2023
62 of 63 checks passed
@julienrbrt julienrbrt deleted the julien/improve-extrainfo branch November 10, 2023 11:28
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