Refactor CronJob
and MultiVersion
Sample Code to Align with DeployImage
Plugin Scaffold Structure
#4291
Labels
help wanted
Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.
kind/cleanup
Categorizes issue or PR as related to cleaning up code, process, or technical debt.
kind/documentation
Categorizes issue or PR as related to documentation.
testing
What do you want to happen?
This issue proposes refactoring the CronJob and MultiVersion samples to follow the structure and best practices introduced by the
DeployImage
plugin, which includes scaffolding to manage resources defined via command-line inputs, such as images.Objectives
The main goals for this refactoring include ensure:
CronJob
andMultiVersion
examples with the scaffolded layout used by theDeployImage
plugin.DeployImage
scaffolded layout, with comprehensive tests for the controller logic.(see that we have indeed a task for that: Review and Improve Test Coverage and Alignment for Controller Tests in CronJob Tutorial #4140)CronJob
andMultiVersion
examples.Reference Materials
To align with
DeployImage
scaffolding, please review the following examples:Additional Notes
All sample updates should be implemented to ensure they match the
DeployImage
plugin’s scaffold structure and best practices, while still fulfilling the unique requirements of each sample (i.e.,CronJob
andMultiVersion
functionality).Related tasks:
Example of Motivation: #4290
Updating the Documentation Samples
Please note that these sample files are auto-generated for the documentation. Any changes made to these samples will be reflected in the documentation only when running
make generate-docs
.The sample generation process is managed through:
Note: We can approach this refactoring with multiple smaller PRs or a single comprehensive one. For example, we could start by adding Status Conditions, then improve the tests, and so on.
Extra Labels
No response
The text was updated successfully, but these errors were encountered: