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)!: remove dependency on C graphviz #11934

Merged
merged 23 commits into from
May 12, 2022
Merged

Conversation

aaronc
Copy link
Member

@aaronc aaronc commented May 11, 2022

Description

Closes: #11925

This replace the dependency on https://pkg.go.dev/github.com/goccy/go-graphviz which wraps the whole C Graphviz library and is causing ARM build problems in #11924 and generally probably shouldn't be used because it's a heavyweight dependency just used for debugging.

It adds:

  • a custom graphviz package that does just what we need for container
  • updates to graphviz rendering to make it nicer and a README with some examples
  • golden tests for graphviz and log debugging
  • a StderrLogger DebugOption which is now the default for Debug/AutoDebug

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)

@github-actions github-actions bot added the C:depinject Issues and PR related to depinject label May 11, 2022
@aaronc aaronc marked this pull request as ready for review May 11, 2022 17:30
@aaronc aaronc requested a review from a team as a code owner May 11, 2022 17:30
Comment on lines +5 to +9
TODO

## Usage

TODO
Copy link
Contributor

Choose a reason for hiding this comment

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

We should ideally fill these out, albeit it can be concise for now.

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 added an issue for this: #11944

@aaronc aaronc added the A:automerge Automatically merge PR once all prerequisites pass. label May 11, 2022
@mergify mergify bot merged commit 7a31a28 into main May 12, 2022
@mergify mergify bot deleted the aaronc/11925-graphviz branch May 12, 2022 17:00
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.

Remove container graphviz dependency
4 participants