Improve OCM CLI using upstream cobra library

[robertwol]

User Story:

Description

As a user and contributor of the OCM project, I want the CLI (Command Line Interface) to be more maintainable and accessible. Currently, the CLI code consists of utility functions and lacks compatibility with the upstream Cobra library. By migrating to the upstream Cobra library, we can improve the CLI's code structure, enhance documentation, and make it easier for contributors to understand and update the linked libraries.

Epic link:

• OCM Simplification and Ease-of-use open-component-model/ocm-project#125

Potential Tasks

1. Task 1: Research and Evaluation

   • Evaluate the current CLI implementation and the benefits of migrating to the upstream cobra library.
   • Identify any challenges or potential roadblocks in the migration process.
   • Document the findings and prepare a migration plan.

2. Task 2: Migration to Upstream Cobra

   • Integrate the upstream cobra library into the OCM project's CLI.
   • Update the CLI codebase to utilize the features and conventions provided by cobra.
   • Ensure compatibility with the latest version of the cobra library.
   • Test the migrated CLI for correctness and functionality.

3. Task 3: Documentation and Examples

   • Update the CLI documentation to reflect the changes made during the migration.
   • Provide clear instructions on how to use the CLI commands and features based on the upstream cobra library.
   • Create a set of examples and tutorials to demonstrate common CLI usage scenarios.
   • Include explanations and best practices to guide users and contributors effectively.

4. Task 4: Community Engagement

   • Communicate the CLI migration to the OCM community through documentation, blog posts, or release notes.
   • Encourage users and contributors to provide feedback and report any issues encountered with the updated CLI.
   • Collaborate with the community to address their concerns and provide support during the transition.

Definition of Done

• [ ] The CLI codebase is migrated to the upstream cobra library.
• [ ] The CLI functionality is maintained or improved after the migration.
• [ ] Documentation is updated to reflect the changes and includes clear usage instructions, examples, and best practices.
• [ ] The migrated CLI is tested thoroughly and ensures compatibility with the latest cobra library version.
• [ ] The OCM community is informed about the CLI migration, and their feedback is actively addressed.

Related issues:

• open-component-model/ocm-project#118 (just mention the number of the related issue here, it will appear as clickable link later)
• open-component-model/ocm-project#117 (just mention the number of the related issue here, it will appear as clickable link later)

From Brainstorming

CLI: use upstream cobra library rather than utility functions or fork. this makes it easier for contributors to become quickly familar

[morri-son]

@mandelsoft , wasn't it the case that upstream cobra was missing something that we urgently required?

[github-actions[bot]]

This issue was marked as stale because it has not had recent activity.