Skip to content

Add sanity CI workflow for all scenarios + update README to reflect latest resources#1

Merged
chefgs merged 30 commits intomainfrom
copilot/add-github-pages-and-readme
Mar 4, 2026
Merged

Add sanity CI workflow for all scenarios + update README to reflect latest resources#1
chefgs merged 30 commits intomainfrom
copilot/add-github-pages-and-readme

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 3, 2026

This pull request introduces significant improvements to DevOps-OS, focusing on enhanced documentation, expanded CLI capabilities, comprehensive automated testing, and continuous integration/deployment workflows. The changes make the platform easier to use, better tested, and ready for automated deployment and documentation hosting.

Key changes:

Documentation and User Experience Improvements

  • Completely rewrote and expanded the README.md to provide a clear value proposition, detailed quick start, usage examples for all major features, and a comprehensive directory overview. Added sections for testing and improved documentation links. [1] [2] [3]
  • Updated generator script references and usage examples in the documentation to reflect the unified CLI structure and new tools.

CLI Enhancements

  • Extended the unified CLI (cli/devopsos.py) to support new scaffold targets: gitlab, argocd, and sre, in addition to existing gha and jenkins options. This provides a single entry point for all major DevOps-OS generators. [1] [2]

Automated Testing and CI/CD

  • Added a comprehensive GitHub Actions workflow (.github/workflows/sanity.yml) that runs all major CLI and server scenarios, covering CI/CD pipeline generation, Kubernetes, SRE, and AI skill definitions on every push and pull request. Generates and uploads a combined HTML test report.
  • Introduced a standard CI workflow (.github/workflows/ci.yml) to run CLI and server unit tests automatically on pushes and PRs.

Documentation Site and Deployment

  • Added a GitHub Pages workflow (.github/workflows/pages.yml) and a _config.yml for Jekyll, enabling automated building and deployment of the documentation site using the Cayman theme. [1] [2]

These updates make DevOps-OS more robust, user-friendly, and maintainable, with improved onboarding, automated validation, and public documentation.The existing ci.yml only ran cli/test_cli.py and mcp_server/test_server.py, leaving tests/test_comprehensive.py (13 scenario classes, 165 tests) outside of CI. Root README was also missing references to test reports and the new tests/ directory.

.github/workflows/sanity.yml (new)

  • Triggers on every push (all branches) and PRs to main
  • One named step per test class for per-scenario visibility in the Actions UI:
    • CLI scaffolds: GHA, Jenkins, GitLab CI, ArgoCD/Flux, SRE
    • MCP server tools: GHA, Jenkins, K8s, GitLab CI, ArgoCD/Flux, SRE, Dev container
    • AI skills definitions
    • CLI integration + MCP server unit tests
  • All tests run against in-memory mock data — no real infrastructure needed
  • if: always() final steps generate and upload a self-contained sanity-report.html artifact (30-day retention)

README.md

  • Repository Structure — converted to table; added tests/ and scripts/ rows; lists all scaffold scripts by name under cli/
  • Testing section (new) — documents the run command, latest pass/xfail summary, links to docs/TEST_REPORT.md, docs/test-reports/test-report.html, docs/test-reports/cli-output-examples.md, and the new sanity workflow
  • Available Documentationkubernetes-capabilities.md promoted from a trailing sentence to a proper table row; deduplication cleanup

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: chefgs <7605658+chefgs@users.noreply.github.com>
Copilot AI changed the title [WIP] Create GitHub Pages and end user README for project Add GitHub Pages, MCP server, quick-start README, and Claude/OpenAI AI skills Mar 3, 2026
…nerators

Co-authored-by: chefgs <7605658+chefgs@users.noreply.github.com>
Copilot AI changed the title Add GitHub Pages, MCP server, quick-start README, and Claude/OpenAI AI skills Add getting-started doc, GitLab CI, ArgoCD/Flux GitOps, and SRE scaffold generators Mar 3, 2026
@chefgs chefgs requested a review from Copilot March 4, 2026 05:34
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR expands DevOps-OS beyond GitHub Actions + Jenkins by adding GitLab CI, ArgoCD/Flux GitOps scaffolding, and SRE configuration generators, plus an MCP server + AI skill definitions and new/updated documentation to make these capabilities accessible via CLI and AI assistants.

Changes:

  • Add new scaffold generators: GitLab CI (cli/scaffold_gitlab.py), ArgoCD/Flux (cli/scaffold_argocd.py), and SRE configs (cli/scaffold_sre.py), and expose them through the unified CLI.
  • Introduce an MCP server (mcp_server/) exposing generator functions as tools, along with Claude/OpenAI tool definitions under skills/.
  • Add/refresh documentation and repo plumbing (Getting Started guide, per-generator docs, Pages config/workflows, CI workflow, .gitignore).

Reviewed changes

Copilot reviewed 21 out of 22 changed files in this pull request and generated 13 comments.

Show a summary per file
File Description
skills/openai_functions.json Adds OpenAI function-calling tool definitions for all generators (including new GitLab/ArgoCD/SRE tools).
skills/claude_tools.json Adds Claude tool definitions for all generators (including new GitLab/ArgoCD/SRE tools).
skills/README.md Documents how to load and use skills with Claude/OpenAI; needs table update to include new tools.
mcp_server/test_server.py Adds tests for MCP tool functions, including new GitLab/ArgoCD/SRE tools.
mcp_server/server.py Implements MCP tools wrapping scaffold modules and direct K8s/devcontainer generation; contains a kubernetes_tools default/schema mismatch.
mcp_server/requirements.txt Adds MCP server Python dependencies.
mcp_server/init.py Declares mcp_server package.
mcp_server/README.md Adds MCP server setup docs; needs tools list updated to include new tools.
docs/SRE-CONFIGURATION-README.md Adds documentation for the SRE config generator.
docs/GITLAB-CI-README.md Adds documentation for the GitLab CI generator.
docs/GETTING-STARTED.md Adds a narrative Getting Started guide spanning generators + AI integration.
docs/ARGOCD-README.md Adds documentation for ArgoCD/Flux GitOps generator.
cli/test_cli.py Expands CLI tests to cover new scaffold generators/targets; includes one ineffective assertion that should be tightened.
cli/scaffold_sre.py Implements SRE configuration generator (PrometheusRule, Grafana dashboard, Sloth SLO, Alertmanager config); contains SLO math/semantics bugs.
cli/scaffold_gitlab.py Implements GitLab CI generator; deploy job image/CLI mismatch for argocd/flux/kustomize and a coverage regex issue.
cli/scaffold_argocd.py Implements ArgoCD/Flux generator; AppProject currently over-permissive (sourceRepos: ["*"]).
cli/devopsos.py Wires new scaffold targets (gitlab/argocd/sre) into the unified Typer CLI.
_config.yml Adds Jekyll site configuration for GitHub Pages.
README.md Updates top-level README with new generators, quick start, and doc links.
.gitignore Adds a basic Python/Jekyll-friendly ignore set.
.github/workflows/pages.yml Adds GitHub Pages build/deploy workflow for docs site.
.github/workflows/ci.yml Adds CI workflow running CLI + MCP server tests.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

… .venv

Co-authored-by: chefgs <7605658+chefgs@users.noreply.github.com>
Copilot AI changed the title Add getting-started doc, GitLab CI, ArgoCD/Flux GitOps, and SRE scaffold generators Add venv setup instructions to all install docs Mar 4, 2026
chefgs and others added 4 commits March 4, 2026 13:24
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
chefgs and others added 2 commits March 4, 2026 13:26
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…lab.py

Co-authored-by: chefgs <7605658+chefgs@users.noreply.github.com>
chefgs and others added 2 commits March 4, 2026 13:30
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: chefgs <7605658+chefgs@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Mar 4, 2026

@copilot make all the requested changes and report back

All requested changes are complete:

  • cli/scaffold_gitlab.py: docker login uses --password-stdin (no password in process args); kustomize deploy method uses kubectl apply -k instead of the standalone kustomize binary; deploy image is method-appropriate and versioned; KUBE_NAMESPACE only emitted when --kube-namespace is passed at generation time.
  • skills/README.md: End-to-end example replaced python -c string interpolation with an explicit TOOL_DISPATCH dict — no arbitrary code execution from model output.
  • cli/scaffold_argocd.py: Removed the unused --custom-values flag, load_custom_values helper, and the now-unnecessary import json.
  • mcp_server/test_server.py: kubernetes_tools test value updated to k9s,kustomize (valid values in all_k8s).
  • All other previously reported items (panel title, doc tables, sourceRepos, kubernetes_tools default, bitnami/kubectl pinning, stale comment) were addressed in earlier commits.

@chefgs chefgs marked this pull request as ready for review March 4, 2026 09:02
Copilot stopped work on behalf of chefgs due to an error March 4, 2026 09:05
Copilot AI and others added 2 commits March 4, 2026 09:12
…h bug documentation

Co-authored-by: chefgs <7605658+chefgs@users.noreply.github.com>
… management

Co-authored-by: chefgs <7605658+chefgs@users.noreply.github.com>
Copilot AI changed the title Add venv setup instructions to all install docs Add comprehensive test suite for DevOps-OS CLI, MCP server, and skills; document 3 bugs Mar 4, 2026
Copilot AI and others added 2 commits March 4, 2026 13:34
Co-authored-by: chefgs <7605658+chefgs@users.noreply.github.com>
…reports/

Co-authored-by: chefgs <7605658+chefgs@users.noreply.github.com>
Copilot AI changed the title Add comprehensive test suite for DevOps-OS CLI, MCP server, and skills; document 3 bugs Add CLI test reports and output examples to docs/test-reports/ Mar 4, 2026
…ut captures and bug report

Co-authored-by: chefgs <7605658+chefgs@users.noreply.github.com>
Copilot AI changed the title Add CLI test reports and output examples to docs/test-reports/ Add comprehensive test suite, CLI output captures, and detailed test report for DevOps-OS Mar 4, 2026
…pository Structure table

Co-authored-by: chefgs <7605658+chefgs@users.noreply.github.com>
Copilot AI changed the title Add comprehensive test suite, CLI output captures, and detailed test report for DevOps-OS Add test reports, CLI output examples, and update root README with resource links Mar 4, 2026
… mock data

Co-authored-by: chefgs <7605658+chefgs@users.noreply.github.com>
Copilot AI changed the title Add test reports, CLI output examples, and update root README with resource links Add sanity CI workflow for all scenarios + update README to reflect latest resources Mar 4, 2026
@chefgs chefgs merged commit 00604ad into main Mar 4, 2026
4 checks passed
@chefgs chefgs deleted the copilot/add-github-pages-and-readme branch March 4, 2026 14:38
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.

3 participants