Refactor internal package organization #839
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
documentation
sjberman
approved these changes
Jul 10, 2023
pleshakov
reviewed
Jul 10, 2023
kate-osborn
force-pushed
the
tech-debt/refactor-packages
branch
from
9cd7c46 to
d5763d5
Compare
kate-osborn
force-pushed
the
tech-debt/refactor-packages
branch
from
d49c136 to
cbaff4d
Compare
miledxz
added a commit
to miledxz/nginx-gateway-fabric
that referenced
this pull request
Jan 14, 2025
Problem: After the merge of the provisioner-mode code into the main branch, our codebase now consists of three distinct components or groups: provisioner-mode, static-mode, and framework. However, our current internal package structure does not align with these components. Solution: Align the internal package structure with our three main components by introducing the following internal packages: - framework: code shared between provisioner and static modes - mode/provisioner: all code related to provisioner-mode - mode/static: all code related to static mode In addition, some packages were refactored/split so the framework package would not have any dependencies on the mode/static package.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
Refactors the internal package organization to better reflect the purpose of the code.
Problem: After the merge of the provisioner-mode code into the main branch commit, our codebase now consists of three distinct components or groups: provisioner-mode, static-mode, and framework. However, our current internal package structure does not align with these components.
Solution: Align the internal package structure with our three main components by introducing the following internal packages:
Some packages were refactored/split so the framework package would not have any dependencies on the mode/static package.
Testing: Made sure unit tests and conformance tests still pass. Ran through the installation doc.
Closes #709
Checklist
Before creating a PR, run through this checklist and mark each as complete.