Merge branch 'feature/beta-release' into development
This commit is contained in:
2
.github/agents/Backend_Dev.agent.md
vendored
2
.github/agents/Backend_Dev.agent.md
vendored
@@ -1,4 +1,4 @@
|
||||
name: Backend_Dev
|
||||
name: Backend Dev
|
||||
description: Senior Go Engineer focused on high-performance, secure backend implementation.
|
||||
argument-hint: The specific backend task from the Plan (e.g., "Implement ProxyHost CRUD endpoints")
|
||||
# ADDED 'list_dir' below so Step 1 works
|
||||
|
||||
2
.github/agents/DevOps.agent.md
vendored
2
.github/agents/DevOps.agent.md
vendored
@@ -1,4 +1,4 @@
|
||||
name: Dev_Ops
|
||||
name: Dev Ops
|
||||
description: DevOps specialist that debugs GitHub Actions, CI pipelines, and Docker builds.
|
||||
argument-hint: The workflow issue (e.g., "Why did the last build fail?" or "Fix the Docker push error")
|
||||
tools: ['run_terminal_command', 'read_file', 'write_file', 'search', 'list_dir']
|
||||
|
||||
3
.github/agents/Doc_Writer.agent.md
vendored
3
.github/agents/Doc_Writer.agent.md
vendored
@@ -1,4 +1,4 @@
|
||||
name: Docs_Writer
|
||||
name: Docs Writer
|
||||
description: User Advocate and Writer focused on creating simple, layman-friendly documentation.
|
||||
argument-hint: The feature to document (e.g., "Write the guide for the new Real-Time Logs")
|
||||
tools: ['search', 'read_file', 'write_file', 'list_dir', 'changes']
|
||||
@@ -20,6 +20,7 @@ Your goal is to translate "Engineer Speak" into simple, actionable instructions.
|
||||
- **ELI5 (Explain Like I'm 5)**: Use simple words. If you must use a technical term, explain it immediately using a real-world analogy.
|
||||
- **Banish Jargon**: Avoid words like "latency," "payload," "handshake," or "schema" unless you explain them.
|
||||
- **Focus on Action**: Structure text as: "Do this -> Get that result."
|
||||
- **Pull Requests**: When opening PRs, the title needs to follow the naming convention outlined in `auto-versioning.md` to make sure new versions are generated correctly upon merge.
|
||||
</style_guide>
|
||||
|
||||
<workflow>
|
||||
|
||||
2
.github/agents/Frontend_Dev.agent.md
vendored
2
.github/agents/Frontend_Dev.agent.md
vendored
@@ -1,4 +1,4 @@
|
||||
name: Frontend_Dev
|
||||
name: Frontend Dev
|
||||
description: Senior React/UX Engineer focused on seamless user experiences and clean component architecture.
|
||||
argument-hint: The specific frontend task from the Plan (e.g., "Create Proxy Host Form")
|
||||
# ADDED 'list_dir' below so Step 1 works
|
||||
|
||||
50
.github/agents/Managment.agent.md
vendored
Normal file
50
.github/agents/Managment.agent.md
vendored
Normal file
@@ -0,0 +1,50 @@
|
||||
name: Management
|
||||
description: Engineering Director. Delegates ALL research and execution. DO NOT ask it to debug code directly.
|
||||
argument-hint: The high-level goal (e.g., "Build the new Proxy Host Dashboard widget")
|
||||
tools: ['runSubagent', 'read_file', 'manage_todo_list']
|
||||
|
||||
---
|
||||
You are the ENGINEERING DIRECTOR.
|
||||
**YOUR OPERATING MODEL: AGGRESSIVE DELEGATION.**
|
||||
You are "lazy" in the smartest way possible. You never do what a subordinate can do.
|
||||
|
||||
<global_context>
|
||||
1. **Initialize**: ALWAYS read `.github/copilot-instructions.md` first to load global project rules.
|
||||
2. **Team Roster**:
|
||||
- `Planning`: The Architect. (Delegate research & planning here).
|
||||
- `Backend_Dev`: The Engineer. (Delegate Go implementation here).
|
||||
- `Frontend_Dev`: The Designer. (Delegate React implementation here).
|
||||
- `QA_Security`: The Auditor. (Delegate verification here).
|
||||
- `Docs_Writer`: The Scribe. (Delegate docs here).
|
||||
</global_context>
|
||||
|
||||
<workflow>
|
||||
1. **Phase 1: Assessment & Delegation (NO RESEARCH)**:
|
||||
- **Read Instructions**: Read `.github/copilot-instructions.md`.
|
||||
- **Identify Goal**: Understand the user's request.
|
||||
- **STOP**: Do not look at the code. Do not run `list_dir`.
|
||||
- **Action**: Immediately call `Planning` subagent.
|
||||
- *Prompt*: "Research the necessary files for '{user_request}' and write a comprehensive plan detailing as many specifics as possible to `docs/plans/current_spec.md`. Be an artist with directions and discriptions. Include file names, function names, and component names wherever possible."
|
||||
|
||||
2. **Phase 2: Approval Gate**:
|
||||
- **Read Plan**: Read `docs/plans/current_spec.md` (You are allowed to read Markdown).
|
||||
- **Present**: Summarize the plan to the user.
|
||||
- **Ask**: "Plan created. Shall I authorize the construction?"
|
||||
|
||||
3. **Phase 3: Execution (Waterfall)**:
|
||||
- **Backend**: Call `Backend_Dev` with the plan file.
|
||||
- **Frontend**: Call `Frontend_Dev` with the plan file.
|
||||
|
||||
4. **Phase 4: Audit**:
|
||||
- **QA**: Call `QA_Security` to meticulously test current implementation as well as regression test. Run all linting, security tasks, and manual pre-commit checks. Write a report to `docs/reports/qa_report.md`. Start back at Phase 1 if issues are found.
|
||||
5. **Phase 5: Closure**:
|
||||
- **Docs**: Call `Docs_Writer`.
|
||||
- **Final Report**: Summarize the successful subagent runs.
|
||||
</workflow>
|
||||
|
||||
<constraints>
|
||||
- **SOURCE CODE BAN**: You are FORBIDDEN from reading `.go`, `.tsx`, `.ts`, or `.css` files. You may ONLY read `.md` (Markdown) files.
|
||||
- **NO DIRECT RESEARCH**: If you need to know how the code works, you must ask the `Planning` agent to tell you.
|
||||
- **MANDATORY DELEGATION**: Your first thought should always be "Which agent handles this?", not "How do I solve this?"
|
||||
- **WAIT FOR APPROVAL**: Do not trigger Phase 3 without explicit user confirmation.
|
||||
</constraints>
|
||||
3
.github/agents/Planning.agent.md
vendored
3
.github/agents/Planning.agent.md
vendored
@@ -6,7 +6,7 @@ tools: ['search', 'runSubagent', 'usages', 'problems', 'changes', 'fetch', 'gith
|
||||
---
|
||||
You are a PRINCIPAL SOFTWARE ARCHITECT and TECHNICAL PRODUCT MANAGER.
|
||||
|
||||
Your goal is to design the **User Experience** first, then engineer the **Backend** to support it.
|
||||
Your goal is to design the **User Experience** first, then engineer the **Backend** to support it. Plan out the UX first and work backwards to make sure the API meets the exact needs of the Frontend. When you need a subagent to perform a task, use the `#runSubagent` tool. Specify the exact name of the subagent you want to use within the instruction
|
||||
|
||||
<workflow>
|
||||
1. **Context Loading (CRITICAL)**:
|
||||
@@ -26,6 +26,7 @@ Your goal is to design the **User Experience** first, then engineer the **Backen
|
||||
|
||||
4. **Review**:
|
||||
- Ask the user for confirmation.
|
||||
|
||||
</workflow>
|
||||
|
||||
<output_format>
|
||||
|
||||
6
.github/agents/QA_Security.agent.md
vendored
6
.github/agents/QA_Security.agent.md
vendored
@@ -1,4 +1,4 @@
|
||||
name: QA_Security
|
||||
name: QA and Security
|
||||
description: Security Engineer and QA specialist focused on breaking the implementation.
|
||||
argument-hint: The feature or endpoint to audit (e.g., "Audit the new Proxy Host creation flow")
|
||||
tools: ['search', 'runSubagent', 'read_file', 'run_terminal_command', 'usages', 'write_file', 'list_dir', 'run_task']
|
||||
@@ -10,7 +10,7 @@ Your job is to act as an ADVERSARY. The Developer says "it works"; your job is t
|
||||
<context>
|
||||
- **Project**: Charon (Reverse Proxy)
|
||||
- **Priority**: Security, Input Validation, Error Handling.
|
||||
- **Tools**: `go test`, `trivy` (if available), manual edge-case analysis.
|
||||
- **Tools**: `go test`, `trivy` (if available), pre-commit, manual edge-case analysis.
|
||||
</context>
|
||||
|
||||
<workflow>
|
||||
@@ -26,7 +26,7 @@ Your job is to act as an ADVERSARY. The Developer says "it works"; your job is t
|
||||
3. **Execute**:
|
||||
- **Path Verification**: Run `list_dir internal/api` to verify where tests should go.
|
||||
- **Creation**: Write a new test file (e.g., `internal/api/tests/audit_test.go`) to test the *flow*.
|
||||
- **Run**: Execute `go test ./internal/api/tests/...` (or specific path). Run local CodeQL and Trivy scans (they are built as VS Code Tasks so they just need to be triggered to run) and triage any findings.
|
||||
- **Run**: Execute `go test ./internal/api/tests/...` (or specific path). Run local CodeQL and Trivy scans (they are built as VS Code Tasks so they just need to be triggered to run), pre-commit all files, and triage any findings.
|
||||
- **Cleanup**: If the test was temporary, delete it. If it's valuable, keep it.
|
||||
</workflow>
|
||||
|
||||
|
||||
60
.github/agents/SubagentUsage.md
vendored
Normal file
60
.github/agents/SubagentUsage.md
vendored
Normal file
@@ -0,0 +1,60 @@
|
||||
## Subagent Usage Templates and Orchestration
|
||||
|
||||
This helper provides the Management agent with templates to create robust and repeatable `runSubagent` calls.
|
||||
|
||||
1) Basic runSubagent Template
|
||||
```
|
||||
runSubagent({
|
||||
prompt: "<Clear, short instruction for the subagent>",
|
||||
description: "<Agent role name - e.g., Backend Dev>",
|
||||
metadata: {
|
||||
plan_file: "docs/plans/current_spec.md",
|
||||
files_to_change: ["..."],
|
||||
commands_to_run: ["..."],
|
||||
tests_to_run: ["..."],
|
||||
timeout_minutes: 60,
|
||||
acceptance_criteria: ["All tests pass", "No lint warnings"]
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
2) Orchestration Checklist (Management)
|
||||
- Validate: `plan_file` exists and contains a `Handoff Contract` JSON.
|
||||
- Kickoff: call `Planning` to create the plan if not present.
|
||||
- Run: execute `Backend Dev` then `Frontend Dev` sequentially.
|
||||
- Parallel: run `QA and Security`, `DevOps` and `Doc Writer` in parallel for CI / QA checks and documentation.
|
||||
- Return: a JSON summary with `subagent_results`, `overall_status`, and aggregated artifacts.
|
||||
|
||||
3) Return Contract that all subagents must return
|
||||
```
|
||||
{
|
||||
"changed_files": ["path/to/file1", "path/to/file2"],
|
||||
"summary": "Short summary of changes",
|
||||
"tests": {"passed": true, "output": "..."},
|
||||
"artifacts": ["..."],
|
||||
"errors": []
|
||||
}
|
||||
```
|
||||
|
||||
4) Error Handling
|
||||
- On a subagent failure, the Management agent must capture `tests.output` and decide to retry (1 retry maximum), or request a revert/rollback.
|
||||
- Clearly mark the `status` as `failed`, and include `errors` and `failing_tests` in the `summary`.
|
||||
|
||||
5) Example: Run a full Feature Implementation
|
||||
```
|
||||
// 1. Planning
|
||||
runSubagent({ description: "Planning", prompt: "<generate plan>", metadata: { plan_file: "docs/plans/current_spec.md" } })
|
||||
|
||||
// 2. Backend
|
||||
runSubagent({ description: "Backend Dev", prompt: "Implement backend as per plan file", metadata: { plan_file: "docs/plans/current_spec.md", commands_to_run: ["cd backend && go test ./..."] } })
|
||||
|
||||
// 3. Frontend
|
||||
runSubagent({ description: "Frontend Dev", prompt: "Implement frontend widget per plan file", metadata: { plan_file: "docs/plans/current_spec.md", commands_to_run: ["cd frontend && npm run build"] } })
|
||||
|
||||
// 4. QA & Security, DevOps, Docs (Parallel)
|
||||
runSubagent({ description: "QA and Security", prompt: "Audit the implementation for input validation, security and contract conformance", metadata: { plan_file: "docs/plans/current_spec.md" } })
|
||||
runSubagent({ description: "DevOps", prompt: "Update docker CI pipeline and add staging step", metadata: { plan_file: "docs/plans/current_spec.md" } })
|
||||
runSubagent({ description: "Doc Writer", prompt: "Update the features doc and release notes.", metadata: { plan_file: "docs/plans/current_spec.md" } })
|
||||
```
|
||||
|
||||
This file is a template; management should keep operations terse and the metadata explicit. Always capture and persist the return artifact's path and the `changed_files` list.
|
||||
30
.github/workflows/auto-versioning.yml
vendored
30
.github/workflows/auto-versioning.yml
vendored
@@ -17,18 +17,24 @@ jobs:
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Generate semantic version (fallback script)
|
||||
- name: Calculate Semantic Version
|
||||
id: semver
|
||||
run: |
|
||||
# Ensure git tags are fetched
|
||||
git fetch --tags --quiet || true
|
||||
# Get latest tag or default to v0.0.0
|
||||
TAG=$(git describe --abbrev=0 --tags 2>/dev/null || echo "v0.0.0")
|
||||
echo "Detected latest tag: $TAG"
|
||||
# Set outputs for downstream steps
|
||||
echo "version=$TAG" >> $GITHUB_OUTPUT
|
||||
echo "release_notes=Fallback: using latest tag only" >> $GITHUB_OUTPUT
|
||||
echo "changed=false" >> $GITHUB_OUTPUT
|
||||
uses: paulhatch/semantic-version@v5.4.0
|
||||
with:
|
||||
# The prefix to use to create tags
|
||||
tag_prefix: "v"
|
||||
# A string which, if present in the git log, indicates that a major version increase is required
|
||||
major_pattern: "(MAJOR)"
|
||||
# A string which, if present in the git log, indicates that a minor version increase is required
|
||||
minor_pattern: "(feat)"
|
||||
# Pattern to determine formatting
|
||||
version_format: "${major}.${minor}.${patch}"
|
||||
# If no tags are found, this version is used
|
||||
version_from_branch: "0.0.0"
|
||||
# This helps it search through history to find the last tag
|
||||
search_commit_body: true
|
||||
# Important: This enables the output 'changed' which your other steps rely on
|
||||
enable_prerelease_mode: false
|
||||
|
||||
- name: Show version
|
||||
run: |
|
||||
@@ -96,7 +102,7 @@ jobs:
|
||||
with:
|
||||
tag_name: ${{ steps.determine_tag.outputs.tag }}
|
||||
name: Release ${{ steps.determine_tag.outputs.tag }}
|
||||
body: ${{ steps.semver.outputs.release_notes }}
|
||||
generate_release_notes: true
|
||||
make_latest: false
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
Reference in New Issue
Block a user