Skip to content

AGENTS.md

Latest commit

 

History

History
56 lines (40 loc) · 3.76 KB

AGENTS.md

File metadata and controls

56 lines (40 loc) · 3.76 KB
Raw

AI Agent Guide for MicroShift

Context Index

Find the right document for each topic:

Topic Document
Design goals and principles docs/contributor/design.md
Technical architecture and code structure docs/contributor/architecture.md
Contributing, building, testing CONTRIBUTING.md
Rebase overview (upstream relationship) docs/contributor/rebase/rebase.md
Rebase step-by-step procedure docs/contributor/rebase/procedure.md
Rebase conventions and pitfalls docs/contributor/rebase/guidelines.md
Test harness (scenarios, VMs, blueprints) docs/contributor/test_harness.md
OpenShift CI and Prow jobs docs/contributor/openshift_ci.md
Enabled OpenShift APIs docs/contributor/enabled_apis.md
User documentation index docs/user/README.md
Contributor documentation index docs/contributor/README.md

Claude Code Plugins

MicroShift plugins are distributed via the edge-tooling marketplace. See .claude/README.md for installation instructions.

Plugin Skills Purpose
microshift-ci /microshift-ci:doctor, /microshift-ci:doctor-refresh, /microshift-ci:prow-job, /microshift-ci:test-job, /microshift-ci:test-scenario, /microshift-ci:create-bugs, /microshift-ci:continue-session CI job analysis, failure triage, bug creation and management
microshift-dev /microshift-dev:add-enhancement, /microshift-dev:generate-tests, /microshift-dev:analyze-sos-report, /microshift-dev:analyze-start-time, /microshift-dev:golang-cve-analyzer Development workflows, test generation, diagnostics
microshift-release /microshift-release:pre-check, /microshift-release:validate-artifacts, /microshift-release:release-versions, /microshift-release:automated-testing Release version tracking, artifact validation, release testing

Guardrails

Rules for AI agents working in this repository:

Do Not Edit (Rebase-Managed)

These files are auto-generated by scripts/auto-rebase/rebase.sh and rebase-lvms.sh. Manual edits will be overwritten on the next rebase.

  • vendor/ — standard Go vendor directory
  • deps/ — vendored openshift/kubernetes and k8s.io/klog with rebase patches applied (required for vendor checks in ART)
  • assets/ manifests — upstream component manifests
  • assets/optional/ manifests — optional component manifests from operator bundles
  • pkg/release/release_*.go — container image references
  • Makefile.version.*.var, Makefile.kube_git.var — version tracking files

Paired Changes

These files must be updated together:

  • Config changes: pkg/config/ Go structs AND packaging/microshift/config.yaml (default config)
  • Test changes: Go code changes should include corresponding Robot Framework test cases in test/suites/
  • New optional component: rebase script in scripts/auto-rebase/ AND health check entry in pkg/healthcheck/microshift_optional_workloads.go AND RPM section in packaging/rpm/microshift.spec

Codebase Patterns

For the full architecture (package structure, manifest system, optional components, config model), see architecture.md. For test harness details (scenarios, naming conventions, blueprint layers, VM lifecycle), see test_harness.md.