feat: Configurable Sync Config Location Override#32
Open
stevensJourney wants to merge 21 commits intomainfrom
Open
feat: Configurable Sync Config Location Override#32stevensJourney wants to merge 21 commits intomainfrom
stevensJourney wants to merge 21 commits intomainfrom
Conversation
…ion and deploy commands.
…ch the current schema. Fix regression where region validation was dropped for deploy commands. Apply provision workarround for sync-config deploys.
Chriztiaan
approved these changes
Mar 18, 2026
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
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.
closes: #23
This adds a
--sync-config-file-path=sync.yamlflag to various commands. This flag allows users to override the path to the sync config file. This flag is only added to commands which use sync config.Implementation
The CLI commands generally fall into these categories:
The
CloudInstanceCommand,SelfHostedInstanceCommandandSharedInstanceCommandsbase command classes handle the respective cases. By convention these commands have aloadProjectmethod which loads the linked project, and also provides the sync config content (if available).This PR adds additional hooks to the respective
loadProjectmethods, in order to resolve thesyncConfig- including the optional ability to override the default path for sync config.Not all instance commands involve the use of Sync Config. For this reason, the
--sync-config-file-pathflag is only added to certain commands. The logic, and flag declaration, is added with aWithSyncConfigFilePathmixin.While implementing the mixin. It was observed that OCLIF already has a built in mechanism for extending flags from base command classes. The commands are updated to use
baseFlagswhen extending, instead of manual spreads. The command flag behaviour was verified to still be consistent with the previous implementation.