Skip to content

feat: major update, focusing on unifying the CLI experience, improving docs, and modernizing the CI/CD scaffolding architecture#19

Merged
chefgs merged 9 commits intomainfrom
copilot/clarify-cli-commands-difference
Mar 8, 2026
Merged

feat: major update, focusing on unifying the CLI experience, improving docs, and modernizing the CI/CD scaffolding architecture#19
chefgs merged 9 commits intomainfrom
copilot/clarify-cli-commands-difference

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 8, 2026

This pull request delivers a major update to the DevOps-OS project, focusing on unifying the CLI experience, improving documentation, and modernizing the CI/CD scaffolding architecture. The highlights include a new single-source version file, a fully unified CLI (devopsos), removal of subprocess calls in favor of direct module invocation, and significant documentation improvements for onboarding and usage.

Key changes:

CLI and Codebase Improvements

  • Refactored scaffold_cicd.py to directly invoke the scaffold_gha and scaffold_jenkins modules using a shared _run_module_main helper, eliminating all subprocess calls and reliance on external script files. This makes the CI/CD generator more robust and maintainable.
  • Introduced cli/__version__.py as the single source of truth for the package version, and updated all version references to 0.2.0. [1] [2]
  • Added a --version / -V flag to the CLI, printing the current version and exiting.

CLI Unification and Help Experience

  • All scaffold subcommands (gha, jenkins, gitlab, argocd, sre, devcontainer, cicd) are now accessed via the unified devopsos CLI. Invoking any subcommand with no options prints its help text and exits cleanly, improving usability and discoverability. [1] [2] [3] [4] [5] [6]

Documentation and Onboarding

  • Major improvements to README.md and README-INDEX.md:
    • Added a clear audience section, quick start command reference, and explicit CLI usage examples for every supported scaffold target.
    • Updated all usage examples and quick references to use the new unified CLI syntax (python -m cli.devopsos scaffold <target>).
    • Added links to new and updated documentation files, including a CLI test report and full command reference. [1] [2] [3] [4] [5] [6] [7] [8]

Project Metadata

  • Added a CHANGELOG.md file to track all notable changes, with semantic versioning links and release notes for v0.2.0. [1] [2]

These changes make DevOps-OS easier to use, more consistent, and simpler to maintain, especially for new contributors and users.

…; clarify devopsos vs scaffold_* distinction

Co-authored-by: chefgs <7605658+chefgs@users.noreply.github.com>
Copilot AI changed the title [WIP] Clarify difference between cli.devopsos and cli.scaffold commands Fix devopsos scaffold arg forwarding and clarify devopsos vs scaffold_* distinction Mar 8, 2026
… per-target options; update all docs

Co-authored-by: chefgs <7605658+chefgs@users.noreply.github.com>
Copilot AI changed the title Fix devopsos scaffold arg forwarding and clarify devopsos vs scaffold_* distinction Unify CLI: replace scaffold pass-through with native Typer sub-app per target Mar 8, 2026
@chefgs chefgs marked this pull request as ready for review March 8, 2026 05:17
…oughout

Co-authored-by: chefgs <7605658+chefgs@users.noreply.github.com>
Copilot AI changed the title Unify CLI: replace scaffold pass-through with native Typer sub-app per target Unify CLI: replace redundant scaffold_* modules with native devopsos scaffold subcommands; update all docs Mar 8, 2026
…exit for all scaffold subcommands

Co-authored-by: chefgs <7605658+chefgs@users.noreply.github.com>
Copilot AI changed the title Unify CLI: replace redundant scaffold_* modules with native devopsos scaffold subcommands; update all docs Fix cicd scaffold broken subprocess calls; add graceful help for all scaffold subcommands when no options given Mar 8, 2026
Co-authored-by: chefgs <7605658+chefgs@users.noreply.github.com>
Copilot AI changed the title Fix cicd scaffold broken subprocess calls; add graceful help for all scaffold subcommands when no options given Fix scaffold cicd broken subprocess calls; graceful help exit for all scaffold subcommands; bump version to 0.2.0 Mar 8, 2026
Copilot AI changed the title Fix scaffold cicd broken subprocess calls; graceful help exit for all scaffold subcommands; bump version to 0.2.0 Bump version to 0.2.0 and add CHANGELOG.md; resolve merge conflicts with main Mar 8, 2026
…on to README

Co-authored-by: chefgs <7605658+chefgs@users.noreply.github.com>
Copilot AI changed the title Bump version to 0.2.0 and add CHANGELOG.md; resolve merge conflicts with main docs: CLI test report, Quick Start Commands cheatsheet, and Audience section (v0.2.0 revamp) Mar 8, 2026
Updated README to reflect changes in CLI commands and rephrased section on platform engineering capabilities.
@chefgs chefgs changed the title docs: CLI test report, Quick Start Commands cheatsheet, and Audience section (v0.2.0 revamp) feat: major update, focusing on unifying the CLI experience, improving docs, and modernizing the CI/CD scaffolding architecture Mar 8, 2026
@chefgs chefgs self-requested a review March 8, 2026 08:15
@chefgs chefgs merged commit 0528417 into main Mar 8, 2026
4 checks passed
@chefgs chefgs deleted the copilot/clarify-cli-commands-difference branch March 8, 2026 09:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants