feat: support previewConfig.target.path#271
Open
lintermansjens wants to merge 1 commit intobaloise:masterfrom
Open
feat: support previewConfig.target.path#271lintermansjens wants to merge 1 commit intobaloise:masterfrom
lintermansjens wants to merge 1 commit intobaloise:masterfrom
Conversation
Member
christiansiegel
left a comment
christiansiegel
left a comment
There was a problem hiding this comment.
Thanks for contributing!
Left a few minor comments regarding log and error outputs. Otherwise LGTM
| preview_env_already_exist = Path(full_preview_folder_path).is_dir() | ||
| if preview_env_already_exist: | ||
| logging.info("Use existing folder for preview: %s", preview_namespace) | ||
| logging.info("Use existing folder for preview: %s (path: %s)", preview_namespace, preview_folder_path) |
Member
There was a problem hiding this comment.
Suggested change
| logging.info("Use existing folder for preview: %s (path: %s)", preview_namespace, preview_folder_path) | |
| logging.info("Use existing folder for preview: %s", preview_folder_path) |
The preview_namespace alone is not really relevant anymore - let's drop it
| logging.info("Use existing folder for preview: %s (path: %s)", preview_namespace, preview_folder_path) | ||
| return False | ||
| logging.info("Create new folder for preview: %s", preview_namespace) | ||
| logging.info("Create new folder for preview: %s (path: %s)", preview_namespace, preview_folder_path) |
Member
There was a problem hiding this comment.
Suggested change
| logging.info("Create new folder for preview: %s (path: %s)", preview_namespace, preview_folder_path) | |
| logging.info("Create new folder for preview: %s", preview_folder_path) |
The preview_namespace alone is not really relevant anymore - let's drop it
| preview_namespace = gitops_config.get_preview_namespace(preview_id) | ||
| logging.info("Preview folder name: %s", preview_namespace) | ||
| preview_folder_path = gitops_config.get_preview_folder_path(preview_id) | ||
| logging.info("Preview folder name: %s (path: %s)", preview_namespace, preview_folder_path) |
Member
There was a problem hiding this comment.
Suggested change
| logging.info("Preview folder name: %s (path: %s)", preview_namespace, preview_folder_path) | |
| logging.info("Preview folder: %s", preview_folder_path) |
| preview_folder_exists = self.__delete_folder_if_exists(preview_target_git_repo, preview_folder_path) | ||
| if not preview_folder_exists: | ||
| if self.__args.expect_preview_exists: | ||
| raise GitOpsException(f"There was no preview with name: {preview_namespace}") |
Member
There was a problem hiding this comment.
Suggested change
| raise GitOpsException(f"There was no preview with name: {preview_namespace}") | |
| raise GitOpsException(f"There was no preview at path: {preview_folder_path}") |
Let's make it more obvious where we were looking for the preview
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
2 participants
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.
Summary
This PR adds support for storing preview environments under a configurable subpath (
previewConfig.target.path) instead of only in the deployment repo root.Why
Some deployment repos keep manifests in certain folders.
Before this change, preview commands only worked with root-level folders.
What changed
Added
previewConfig.target.pathparsing and validation in GitOps config.Added path resolution logic to combine configured target path + generated preview namespace
Updated:
Added tests for:
Updated docs:
Compatibility
Default behavior is unchanged: if
previewConfig.target.pathis not set, previews are still created in the repository root.