diff --git a/docs/README.md b/docs/README.md index 25b7f4e..f071e6e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,40 +1,32 @@ -# KDM CLI — Versioned Command Documentation +# KDM CLI Documentation — v1.2.2 + +## What's Changed +* feat: add credential setup guidance by @fizyxbt in https://github.com/KDM-cli/kdm-cli/pull/23 +* docs: add versioned command documentation structure by @blut-agent in https://github.com/KDM-cli/kdm-cli/pull/28 +* feat: add auto-labeling and issue templates by @utkarsh232005 in https://github.com/KDM-cli/kdm-cli/pull/31 +* feat: use custom JS script for PR labeling by @utkarsh232005 in https://github.com/KDM-cli/kdm-cli/pull/32 +* feat: Migrate and Adapt KDM Bot Automation Scripts by @utkarsh232005 in https://github.com/KDM-cli/kdm-cli/pull/33 +* ci: bot automation migration by @utkarsh232005 in https://github.com/KDM-cli/kdm-cli/pull/35 +* ci: fix issue labeler and duplicate CodeRabbit findings by @utkarsh232005 in https://github.com/KDM-cli/kdm-cli/pull/37 +* docs: add contributing and security guidelines by @utkarsh232005 in https://github.com/KDM-cli/kdm-cli/pull/39 +* feat(cli): add auto version checking and update prompt by @blut-agent in https://github.com/KDM-cli/kdm-cli/pull/29 +* fix: version check logic and validation by @utkarsh232005 in https://github.com/KDM-cli/kdm-cli/pull/41 +* fix: implement real functionality for kdm logs and kdm health commands (#1) by @Rishiraj-Pathak-27 in https://github.com/KDM-cli/kdm-cli/pull/40 +* feat: automate versioned CLI command documentation scaffolding and changelog engine by @Yuvraj-Sarathe in https://github.com/KDM-cli/kdm-cli/pull/43 +* fix: refactor publish workflow and remove obsolete bots by @utkarsh232005 in https://github.com/KDM-cli/kdm-cli/pull/45 + +## New Contributors +* @blut-agent made their first contribution in https://github.com/KDM-cli/kdm-cli/pull/28 +* @Rishiraj-Pathak-27 made their first contribution in https://github.com/KDM-cli/kdm-cli/pull/40 +* @Yuvraj-Sarathe made their first contribution in https://github.com/KDM-cli/kdm-cli/pull/43 + +**Full Changelog**: https://github.com/KDM-cli/kdm-cli/compare/v1.2.1...v1.2.2 -This directory contains versioned documentation for all KDM CLI commands. Each section documents a top-level command group with usage, parameters, examples, and troubleshooting. - -## Command Index - -- `show` — Show running runners, pods, containers, or minikube -- `health` — Show health status for pods or containers -- `watch` — Live monitoring mode -- `logs` — Show logs for a container or pod -- `config` — Manage KDM configuration - -## Quick Start - -```bash -# Install globally -npm install -g kdm-cli - -# Show all workloads -kdm show runners - -# Check pod health -kdm health po - -# Live watch -kdm watch - -# View logs -kdm logs - -# Configure notifications -kdm config setup - -``` --- ## Version History -* [v1.2.1](https://www.google.com/search?q=v1.2.1.md) -* [v1.1.0](https://www.google.com/search?q=v1.1.0.md) +* [v1.2.2](v1.2.2.md) +* [v1.2.1](v1.2.1.md) +* [v1.2.0](v1.2.0.md) +* [v1.1.3](v1.1.3.md) \ No newline at end of file diff --git a/docs/v1.1.3.md b/docs/v1.1.3.md new file mode 100644 index 0000000..11376ca --- /dev/null +++ b/docs/v1.1.3.md @@ -0,0 +1,9 @@ +# KDM CLI Documentation — v1.1.3 + +## What's Changed +* Fix/esm compatibility and workflow by @utkarsh232005 in https://github.com/KDM-cli/kdm-cli/pull/8 +* Fix/esm compatibility and workflow by @utkarsh232005 in https://github.com/KDM-cli/kdm-cli/pull/9 +* Fix/esm compatibility and workflow by @utkarsh232005 in https://github.com/KDM-cli/kdm-cli/pull/10 + + +**Full Changelog**: https://github.com/KDM-cli/kdm-cli/compare/v1.1.2...v1.1.3 \ No newline at end of file diff --git a/docs/v1.2.0.md b/docs/v1.2.0.md new file mode 100644 index 0000000..7709e88 --- /dev/null +++ b/docs/v1.2.0.md @@ -0,0 +1,9 @@ +# KDM CLI Documentation — v1.2.0 + +## What's Changed +* added codeowners by @utkarsh232005 in https://github.com/KDM-cli/kdm-cli/pull/11 +* Fix: handle connection errors gracefully and add comprehensive tests by @utkarsh232005 in https://github.com/KDM-cli/kdm-cli/pull/13 +* Feat: interactive notification setup by @utkarsh232005 in https://github.com/KDM-cli/kdm-cli/pull/14 + + +**Full Changelog**: https://github.com/KDM-cli/kdm-cli/compare/v1.1.3...v1.2.0 \ No newline at end of file diff --git a/docs/v1.2.1.md b/docs/v1.2.1.md new file mode 100644 index 0000000..221f25c --- /dev/null +++ b/docs/v1.2.1.md @@ -0,0 +1,15 @@ +# KDM CLI Documentation — v1.2.1 + +## What's Changed +* added codeowners by @utkarsh232005 in https://github.com/KDM-cli/kdm-cli/pull/11 +* Fix: handle connection errors gracefully and add comprehensive tests by @utkarsh232005 in https://github.com/KDM-cli/kdm-cli/pull/13 +* Feat: interactive notification setup by @utkarsh232005 in https://github.com/KDM-cli/kdm-cli/pull/14 +* Fix: bypass branch protection in publish workflow by @utkarsh232005 in https://github.com/KDM-cli/kdm-cli/pull/15 +* Feat: transition to @vr_patel/tui Spinner by @utkarsh232005 in https://github.com/KDM-cli/kdm-cli/pull/17 +* fix: include kdm binary wrapper by @fizyxbt in https://github.com/KDM-cli/kdm-cli/pull/20 +* feat: improve TUI spinner and fix publish workflow by @utkarsh232005 in https://github.com/KDM-cli/kdm-cli/pull/21 + +## New Contributors +* @fizyxbt made their first contribution in https://github.com/KDM-cli/kdm-cli/pull/20 + +**Full Changelog**: https://github.com/KDM-cli/kdm-cli/compare/v1.1.3...v1.2.1 \ No newline at end of file diff --git a/docs/v1.2.2.md b/docs/v1.2.2.md new file mode 100644 index 0000000..2e0bf99 --- /dev/null +++ b/docs/v1.2.2.md @@ -0,0 +1,23 @@ +# KDM CLI Documentation — v1.2.2 + +## What's Changed +* feat: add credential setup guidance by @fizyxbt in https://github.com/KDM-cli/kdm-cli/pull/23 +* docs: add versioned command documentation structure by @blut-agent in https://github.com/KDM-cli/kdm-cli/pull/28 +* feat: add auto-labeling and issue templates by @utkarsh232005 in https://github.com/KDM-cli/kdm-cli/pull/31 +* feat: use custom JS script for PR labeling by @utkarsh232005 in https://github.com/KDM-cli/kdm-cli/pull/32 +* feat: Migrate and Adapt KDM Bot Automation Scripts by @utkarsh232005 in https://github.com/KDM-cli/kdm-cli/pull/33 +* ci: bot automation migration by @utkarsh232005 in https://github.com/KDM-cli/kdm-cli/pull/35 +* ci: fix issue labeler and duplicate CodeRabbit findings by @utkarsh232005 in https://github.com/KDM-cli/kdm-cli/pull/37 +* docs: add contributing and security guidelines by @utkarsh232005 in https://github.com/KDM-cli/kdm-cli/pull/39 +* feat(cli): add auto version checking and update prompt by @blut-agent in https://github.com/KDM-cli/kdm-cli/pull/29 +* fix: version check logic and validation by @utkarsh232005 in https://github.com/KDM-cli/kdm-cli/pull/41 +* fix: implement real functionality for kdm logs and kdm health commands (#1) by @Rishiraj-Pathak-27 in https://github.com/KDM-cli/kdm-cli/pull/40 +* feat: automate versioned CLI command documentation scaffolding and changelog engine by @Yuvraj-Sarathe in https://github.com/KDM-cli/kdm-cli/pull/43 +* fix: refactor publish workflow and remove obsolete bots by @utkarsh232005 in https://github.com/KDM-cli/kdm-cli/pull/45 + +## New Contributors +* @blut-agent made their first contribution in https://github.com/KDM-cli/kdm-cli/pull/28 +* @Rishiraj-Pathak-27 made their first contribution in https://github.com/KDM-cli/kdm-cli/pull/40 +* @Yuvraj-Sarathe made their first contribution in https://github.com/KDM-cli/kdm-cli/pull/43 + +**Full Changelog**: https://github.com/KDM-cli/kdm-cli/compare/v1.2.1...v1.2.2 \ No newline at end of file