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(container)!: move logging and visualization options to DebugOption #10302

Merged
merged 8 commits into from
Oct 14, 2021

Conversation

aaronc
Copy link
Member

@aaronc aaronc commented Oct 4, 2021

Description


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
  • 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)

@aaronc aaronc changed the title refactor(container)!: move logging and visualization options to Debug… refactor(container)!: move logging and visualization options to DebugOption Oct 4, 2021
@github-actions github-actions bot added the C:depinject Issues and PR related to depinject label Oct 4, 2021
@aaronc aaronc marked this pull request as ready for review October 4, 2021 21:10
@aaronc aaronc requested a review from alexanderbez as a code owner October 4, 2021 21:10
Copy link
Collaborator

@robert-zaremba robert-zaremba left a comment

Choose a reason for hiding this comment

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

LGTM, left one comment for the DebugOption interface.


// DebugOption is a functional debug option for a container.
type DebugOption interface {
applyConfig(*debugConfig) error
Copy link
Collaborator

Choose a reason for hiding this comment

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

having a private method is to prevent other implementations, right?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes

Copy link
Collaborator

Choose a reason for hiding this comment

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

maybe it's worth to expand the doc comment.

Copy link
Member Author

Choose a reason for hiding this comment

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

I updated the doc comment a bit

@aaronc aaronc added the A:automerge Automatically merge PR once all prerequisites pass. label Oct 5, 2021
@mergify mergify bot merged commit 02e3919 into master Oct 14, 2021
@mergify mergify bot deleted the aaronc/container-debug-config branch October 14, 2021 16:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A:automerge Automatically merge PR once all prerequisites pass. C:depinject Issues and PR related to depinject
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants