forked from diegoecab/oci-deal-accelerator
Why this set of changes:
- KB pricing was drifting silently — domain files (database.yaml,
storage.yaml, etc.) had prices 30-800% off the live Oracle API and
nobody read them. The skill was auditing as stale on every check
with no path to fix it.
- The skill itself violated Anthropic's spec (`name` field had
uppercase/spaces) and was over the 500-line guideline (647 lines),
hurting discovery and load performance.
- Welcome flow occasionally improvised the menu instead of reading
SKILL.md, missing options.
Pricing — single source of truth, fully automated:
- Extend tools/refresh_sku_catalog.py with --refresh-domain compute,
pulls shape-level prices from the Oracle public pricing API
(apexapps.oracle.com), preserves manual fields (notes, GPU specs,
free-tier annotations, estimation_helpers), recomputes derived
monthly values, and protects $0 free-tier prices from overwrite.
- Delete 12 redundant pricing/<domain>.yaml files. They duplicated
oci-sku-catalog.yaml with worse abstractions and were nobody's
source of truth (no tool consumed them).
- Migrate the genuinely valuable knowledge from those 12 files
(billing models, BYOL rules, free-tier rules, ECPU vs OCPU,
X11M elastic model, hyperscaler comparisons, service nuances)
into kb/field-knowledge/pricing-knowledge.yaml — non-numeric,
no refresh needed.
- Result: pricing freshness check goes from 13 stale files to 0.
KB freshness automation:
- Add tools/kb_freshness.py — wrapper around kb_linter.check_freshness()
with --check, --auto-refresh, --json, --quiet modes. Bridges stale
files to their refresh tools (SKU catalog, compute domain, arch
center). Wired into the welcome flow as a pre-flight banner that
asks the user before refreshing.
- Fix pre-existing kb_linter bug: it crashed on the 45 multi-doc
YAML files (frontmatter + body pattern) because it used safe_load
instead of safe_load_all. Freshness check was effectively dead.
- Standardize timestamp field: linter now accepts last_verified,
last_updated, and last_refreshed; refresh_arch_catalog writes
last_verified instead of last_refreshed.
- Add make freshness / make freshness-refresh targets.
Skill alignment with Anthropic Agent Skills best practices:
- Rename `name: OCI Deal Accelerator` to `oci-deal-accelerator`
to comply with the [a-z0-9-]{1,64} spec.
- Refactor SKILL.md from 674 to 445 lines via progressive disclosure:
extract WA review output format, ECAL readiness format, and output
conventions into docs/skill/*.md referenced from the main file.
- Add scripts/sync-skill.py + make sync-skill: source of truth is
root SKILL.md, .agents/skills/oci-deal-accelerator/SKILL.md is
auto-generated. make lint validates sync.
- Add evaluations/ with 3 manual baseline scenarios (welcome-flow,
full-proposal, wa-review) per the Anthropic best-practices guidance
to "build evaluations first."
Welcome flow hardening:
- Tighten CLAUDE.md to MANDATE reading SKILL.md before showing the
menu (no improvising), and document the freshness pre-flight check
with the ask-before-refresh user flow.
- Update SKILL.md welcome flow to instruct: parse kb_freshness JSON,
show banner with stale count + oldest file, prompt user to refresh
(only when an automated tool exists), fall back silently on errors.
Linter hygiene (zero remaining issues):
- Expand config/kb-tags.yaml taxonomy with features, operations,
metrics, limitations sections covering 31 previously-unknown tags
used in field findings (rac, ecpu, refreshable-clone, hnsw, etc.).
- Assign owners for kb/compatibility/, kb/competitive/,
kb/well-architected/ (Diego Cabrera as default until team grows);
kb/pricing/ marked as "Auto-refreshed" since it no longer needs
human ownership.
- kb_linter accepts top-level `date` as fallback for contributor
block; migrate FF-202603-008 from legacy `reported_by` to
contributor block.
- Result: linter goes from 45 issues to 0.
Other:
- Recompute estimation_helpers monthly values in compute.yaml after
the price refresh (they were derived from the old E5/A1 numbers).
- Add kb/README.md — contributor guide (directory map, frontmatter
spec, refresh tooling, review cadence).
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
81 lines
3.1 KiB
Makefile
81 lines
3.1 KiB
Makefile
# OCI Deal Accelerator — Build Automation
|
|
|
|
.PHONY: help install test validate example diagram deck full clean lint codex-package update-icons freshness freshness-refresh sync-skill
|
|
|
|
PYTHON ?= python3.12
|
|
SPEC_DIR = examples
|
|
OUTPUT_DIR = examples/sample-output
|
|
|
|
help: ## Show this help
|
|
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | \
|
|
awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'
|
|
|
|
install: ## Install Python dependencies
|
|
pip install -r requirements.txt
|
|
|
|
validate: ## Validate imports and configs
|
|
$(PYTHON) -c "from tools.oci_diagram_gen import OCIDiagramGenerator; print('Diagram Generator OK')"
|
|
$(PYTHON) -c "from tools.oci_deck_gen import OCIDeckGenerator; print('Deck Generator OK')"
|
|
$(PYTHON) -c "import yaml; yaml.safe_load(open('config/workload-profile-schema.yaml')); print('Schema OK')"
|
|
$(PYTHON) -c "import yaml; yaml.safe_load(open('config/service-categories.yaml')); print('Categories OK')"
|
|
@echo "All validations passed"
|
|
|
|
example: ## Generate sample architecture diagram (.drawio)
|
|
@mkdir -p $(OUTPUT_DIR)
|
|
$(PYTHON) tools/oci_diagram_gen.py \
|
|
--spec $(SPEC_DIR)/migration-adb-ha-dr.yaml \
|
|
--output $(OUTPUT_DIR)/architecture.drawio
|
|
@echo "Generated $(OUTPUT_DIR)/architecture.drawio"
|
|
|
|
diagram: example ## Alias for example
|
|
|
|
deck: ## Generate sample proposal deck (.pptx)
|
|
@mkdir -p $(OUTPUT_DIR)
|
|
$(PYTHON) tools/oci_deck_gen.py \
|
|
--spec $(SPEC_DIR)/migration-adb-ha-dr.yaml \
|
|
--output $(OUTPUT_DIR)/architecture-proposal.pptx
|
|
@echo "Generated $(OUTPUT_DIR)/architecture-proposal.pptx"
|
|
|
|
full: ## Generate all outputs via orchestrator
|
|
$(PYTHON) tools/oci_output.py \
|
|
--spec $(SPEC_DIR)/migration-adb-ha-dr.yaml \
|
|
--output-dir $(OUTPUT_DIR) \
|
|
--format full
|
|
@echo "Generated all outputs in $(OUTPUT_DIR)/"
|
|
|
|
codex-package: ## Package as Codex skill
|
|
@mkdir -p codex/tools
|
|
cp tools/oci_diagram_gen.py codex/tools/
|
|
cp tools/oci_deck_gen.py codex/tools/
|
|
cp tools/oci_output.py codex/tools/
|
|
cp -r kb codex/
|
|
cp -r config codex/
|
|
@echo "Codex skill package ready in codex/"
|
|
|
|
update-icons: ## Re-extract OCI icons after updating OCI Library.xml
|
|
$(PYTHON) tools/oci_icon_extractor.py
|
|
@echo "Updated kb/diagram/oci-icons.json from OCI Library.xml"
|
|
|
|
clean: ## Remove generated output files
|
|
rm -f examples/sample-output/*.drawio
|
|
rm -f examples/sample-output/*.pptx
|
|
rm -f examples/sample-output/*.xlsx
|
|
rm -f examples/sample-output/*.docx
|
|
|
|
lint: ## Check YAML files for syntax errors and validate SKILL.md sync
|
|
@echo "Checking YAML files..."
|
|
@find kb/ config/ examples/ -name '*.yaml' -exec $(PYTHON) -c \
|
|
"import yaml, sys; list(yaml.safe_load_all(open(sys.argv[1])))" {} \; \
|
|
-print 2>&1 | grep -v "^$$" || echo "All YAML files valid."
|
|
@echo "Checking SKILL.md sync..."
|
|
@$(PYTHON) scripts/sync-skill.py --check
|
|
|
|
sync-skill: ## Regenerate .agents/skills/oci-deal-accelerator/SKILL.md from root SKILL.md
|
|
@$(PYTHON) scripts/sync-skill.py
|
|
|
|
freshness: ## Report stale KB files (informational, never fails)
|
|
-@$(PYTHON) tools/kb_freshness.py --check
|
|
|
|
freshness-refresh: ## Run refresh tools for stale KB files that support automation
|
|
@$(PYTHON) tools/kb_freshness.py --auto-refresh
|