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 internal package organization #839

Merged
merged 7 commits into from
Jul 11, 2023

Conversation

kate-osborn
Copy link
Contributor

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:

  • framework: code shared between provisioner and static modes
  • mode/provisioner: all code related to provisioner-mode
  • mode/static: all code related to static mode
    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.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

@kate-osborn kate-osborn requested a review from a team as a code owner July 10, 2023 15:27
@github-actions github-actions bot added documentation Improvements or additions to documentation tech-debt Short-term pain, long-term benefit labels Jul 10, 2023
@kate-osborn kate-osborn marked this pull request as draft July 10, 2023 15:50
@kate-osborn kate-osborn marked this pull request as ready for review July 10, 2023 15:55
internal/framework/config/config.go Outdated Show resolved Hide resolved
internal/framework/manager/filter/filter.go Outdated Show resolved Hide resolved
internal/framework/conditions/conditions.go Outdated Show resolved Hide resolved
internal/mode/static/doc.go Outdated Show resolved Hide resolved
internal/mode/static/handler.go Outdated Show resolved Hide resolved
Copy link
Contributor

@pleshakov pleshakov left a comment

Choose a reason for hiding this comment

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

👍

@kate-osborn kate-osborn merged commit e065469 into nginxinc:main Jul 11, 2023
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation tech-debt Short-term pain, long-term benefit
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Refactor packages
3 participants