-
Notifications
You must be signed in to change notification settings - Fork 46
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
Refac/integrate monitoring pkg #464
base: develop
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
On the one hand, the docker compose manager refactor is neat and very appreciated.
On the other hand, changing the default data directory is a breaking change, which triggers a major version change in the code (v2.0.0) because it breaks existing functionality and user workflows, meaning that this new release is not compatible with other releases.
Users who assume the previous default data directory, when they run their sedge
commands with the release that contains this PR's changes, will find that sedge
is be throwing errors or assuming a different data directory for their setups.
I recommend you to raise a new PR with the data directory changes, and we can merge it when we have enough features to justify a major version change.
CHANGELOG.md
Outdated
### Changed | ||
- Update "sedge-data" default directory. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shouldn't this be under unreleased?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, please share more details about the change, like what to expect from the new default data directory.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed it from here since we will be adding these changes in a new PR. and updated changelog here.
@@ -31,24 +30,21 @@ type RunContainersOptions struct { | |||
} | |||
|
|||
func (s *sedgeActions) RunContainers(options RunContainersOptions) error { | |||
upCmd := s.commandRunner.BuildDockerComposeUpCMD(commands.DockerComposeUpOptions{ | |||
err := s.composeManager.Up(commands.DockerComposeUpOptions{ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It looks like the DockerCompose*Options
should fall under the compose
package rather than under the commands
(after this refactor). WDYT
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The ComposeManager
uses the CommandRunner
interface (in commands
pkg) to build the docker compose commands (which use these options). I think it would be better if we keep the DockerCompose*Options
in the commands
pkg to also prevent an "import cycle" issue.
15d3b7d
to
4f2340d
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #464 +/- ##
===========================================
- Coverage 24.61% 24.60% -0.02%
===========================================
Files 119 119
Lines 22000 22002 +2
===========================================
- Hits 5416 5414 -2
- Misses 16058 16060 +2
- Partials 526 528 +2
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Created a separate PR for updating "sedge-data" default directory #468 |
Changes:
Types of changes
What types of changes does your code introduce?
Put an
x
in the boxes that applyTesting
Requires testing
In case you checked yes, did you write tests?