Documentation
¶
Overview ¶
Package validation provides configuration types for release validation areas. Validation areas represent departments or areas of responsibility in the release process (e.g., QA, Documentation, Release Management, Security).
Validation areas are platform-agnostic and can be converted to tool-specific formats using adapters:
- Claude Code: Sub-agents (agents/*.md)
- Gemini CLI: Commands or prompts (future)
- Codex: Prompts (future)
Example usage:
import (
"github.com/agentplexus/assistantkit/validation"
_ "github.com/agentplexus/assistantkit/validation/claude" // Register Claude adapter
)
// Read canonical validation area
area, err := validation.ReadCanonicalFile("validation/qa.json")
if err != nil {
log.Fatal(err)
}
// Write as Claude agent
adapter, _ := validation.GetAdapter("claude")
err = adapter.WriteFile(area, "agents/qa-validator.md")
Index ¶
Constants ¶
const ( StatusGo = core.StatusGo StatusNoGo = core.StatusNoGo StatusWarn = core.StatusWarn StatusSkip = core.StatusSkip )
Status constants
Variables ¶
var ( AreaQA = core.AreaQA AreaDocumentation = core.AreaDocumentation AreaRelease = core.AreaRelease AreaSecurity = core.AreaSecurity )
Predefined validation areas
Functions ¶
func WriteAreasToDir ¶
func WriteAreasToDir(areas []*ValidationArea, dir string, adapterName string) error
WriteAreasToDir writes validation areas to a directory using the specified adapter.
func WriteCanonicalFile ¶
func WriteCanonicalFile(area *ValidationArea, path string) error
WriteCanonicalFile writes a canonical validation-area.json file.
Types ¶
type Adapter ¶
Adapter is the adapter interface.
func GetAdapter ¶
GetAdapter returns an adapter by name.
type CheckStatus ¶
type CheckStatus = core.CheckStatus
CheckStatus represents the result of a check.
type ValidationArea ¶
type ValidationArea = core.ValidationArea
ValidationArea is the canonical validation area type.
func NewValidationArea ¶
func NewValidationArea(name, description string) *ValidationArea
NewValidationArea creates a new ValidationArea.
func ReadCanonicalDir ¶
func ReadCanonicalDir(dir string) ([]*ValidationArea, error)
ReadCanonicalDir reads all validation-area.json files from a directory.
func ReadCanonicalFile ¶
func ReadCanonicalFile(path string) (*ValidationArea, error)
ReadCanonicalFile reads a canonical validation-area.json file.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package claude provides the Claude Code validation area adapter.
|
Package claude provides the Claude Code validation area adapter. |
|
cmd
|
|
|
generate
command
Command generate creates validation area files from canonical specs.
|
Command generate creates validation area files from canonical specs. |
|
Package codex provides the OpenAI Codex validation area adapter.
|
Package codex provides the OpenAI Codex validation area adapter. |
|
Package core provides canonical types for validation area definitions.
|
Package core provides canonical types for validation area definitions. |
|
Package gemini provides the Gemini CLI validation area adapter.
|
Package gemini provides the Gemini CLI validation area adapter. |