@fractary/core 0.7.24 → 0.7.26
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/docs/type-registry.d.ts.map +1 -1
- package/dist/docs/type-registry.js +4 -5
- package/dist/docs/type-registry.js.map +1 -1
- package/dist/logs/type-registry.d.ts.map +1 -1
- package/dist/logs/type-registry.js +4 -5
- package/dist/logs/type-registry.js.map +1 -1
- package/dist/work/providers/github.d.ts.map +1 -1
- package/dist/work/providers/github.js +10 -2
- package/dist/work/providers/github.js.map +1 -1
- package/package.json +4 -2
- package/templates/docs/adr/standards.md +29 -0
- package/templates/docs/adr/template.md +48 -0
- package/templates/docs/adr/type.yaml +74 -0
- package/templates/docs/api/standards.md +16 -0
- package/templates/docs/api/template.md +62 -0
- package/templates/docs/api/type.yaml +63 -0
- package/templates/docs/architecture/standards.md +15 -0
- package/templates/docs/architecture/template.md +58 -0
- package/templates/docs/architecture/type.yaml +63 -0
- package/templates/docs/audit/standards.md +15 -0
- package/templates/docs/audit/template.md +52 -0
- package/templates/docs/audit/type.yaml +61 -0
- package/templates/docs/changelog/standards.md +15 -0
- package/templates/docs/changelog/template.md +53 -0
- package/templates/docs/changelog/type.yaml +45 -0
- package/templates/docs/dataset/standards.md +15 -0
- package/templates/docs/dataset/template.md +65 -0
- package/templates/docs/dataset/type.yaml +63 -0
- package/templates/docs/etl/standards.md +15 -0
- package/templates/docs/etl/template.md +77 -0
- package/templates/docs/etl/type.yaml +66 -0
- package/templates/docs/guides/standards.md +16 -0
- package/templates/docs/guides/template.md +58 -0
- package/templates/docs/guides/type.yaml +61 -0
- package/templates/docs/infrastructure/standards.md +15 -0
- package/templates/docs/infrastructure/template.md +90 -0
- package/templates/docs/infrastructure/type.yaml +66 -0
- package/templates/docs/manifest.yaml +114 -0
- package/templates/docs/spec-api/standards.md +53 -0
- package/templates/docs/spec-api/template.md +96 -0
- package/templates/docs/spec-api/type.yaml +102 -0
- package/templates/docs/spec-basic/standards.md +24 -0
- package/templates/docs/spec-basic/template.md +51 -0
- package/templates/docs/spec-basic/type.yaml +92 -0
- package/templates/docs/spec-bug/standards.md +46 -0
- package/templates/docs/spec-bug/template.md +66 -0
- package/templates/docs/spec-bug/type.yaml +96 -0
- package/templates/docs/spec-feature/standards.md +53 -0
- package/templates/docs/spec-feature/template.md +105 -0
- package/templates/docs/spec-feature/type.yaml +106 -0
- package/templates/docs/spec-infrastructure/standards.md +58 -0
- package/templates/docs/spec-infrastructure/template.md +71 -0
- package/templates/docs/spec-infrastructure/type.yaml +102 -0
- package/templates/docs/standards/standards.md +15 -0
- package/templates/docs/standards/template.md +54 -0
- package/templates/docs/standards/type.yaml +61 -0
- package/templates/docs/testing/standards.md +15 -0
- package/templates/docs/testing/template.md +87 -0
- package/templates/docs/testing/type.yaml +65 -0
- package/templates/logs/audit/standards.md +33 -0
- package/templates/logs/audit/template.md +65 -0
- package/templates/logs/audit/type.yaml +85 -0
- package/templates/logs/build/standards.md +32 -0
- package/templates/logs/build/template.md +78 -0
- package/templates/logs/build/type.yaml +71 -0
- package/templates/logs/changelog/standards.md +34 -0
- package/templates/logs/changelog/template.md +71 -0
- package/templates/logs/changelog/type.yaml +70 -0
- package/templates/logs/debug/standards.md +33 -0
- package/templates/logs/debug/template.md +63 -0
- package/templates/logs/debug/type.yaml +77 -0
- package/templates/logs/deployment/standards.md +34 -0
- package/templates/logs/deployment/template.md +64 -0
- package/templates/logs/deployment/type.yaml +76 -0
- package/templates/logs/manifest.yaml +70 -0
- package/templates/logs/operational/standards.md +34 -0
- package/templates/logs/operational/template.md +71 -0
- package/templates/logs/operational/type.yaml +87 -0
- package/templates/logs/session/standards.md +34 -0
- package/templates/logs/session/template.md +81 -0
- package/templates/logs/session/type.yaml +69 -0
- package/templates/logs/test/standards.md +34 -0
- package/templates/logs/test/template.md +83 -0
- package/templates/logs/test/type.yaml +75 -0
- package/templates/logs/workflow/standards.md +35 -0
- package/templates/logs/workflow/template.md +95 -0
- package/templates/logs/workflow/type.yaml +91 -0
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
---
|
|
2
|
+
log_type: build
|
|
3
|
+
title: {{title}}
|
|
4
|
+
build_id: {{build_id}}
|
|
5
|
+
date: {{date}}
|
|
6
|
+
status: {{status}}
|
|
7
|
+
{{#repository}}
|
|
8
|
+
repository: {{repository}}
|
|
9
|
+
{{/repository}}
|
|
10
|
+
{{#branch}}
|
|
11
|
+
branch: {{branch}}
|
|
12
|
+
{{/branch}}
|
|
13
|
+
{{#commit_sha}}
|
|
14
|
+
commit_sha: {{commit_sha}}
|
|
15
|
+
{{/commit_sha}}
|
|
16
|
+
{{#build_tool}}
|
|
17
|
+
build_tool: {{build_tool}}
|
|
18
|
+
{{/build_tool}}
|
|
19
|
+
{{#exit_code}}
|
|
20
|
+
exit_code: {{exit_code}}
|
|
21
|
+
{{/exit_code}}
|
|
22
|
+
{{#duration_seconds}}
|
|
23
|
+
duration_seconds: {{duration_seconds}}
|
|
24
|
+
{{/duration_seconds}}
|
|
25
|
+
{{#artifacts}}
|
|
26
|
+
artifacts:
|
|
27
|
+
{{#artifacts}}
|
|
28
|
+
- {{.}}
|
|
29
|
+
{{/artifacts}}
|
|
30
|
+
{{/artifacts}}
|
|
31
|
+
{{#work_id}}
|
|
32
|
+
work_id: {{work_id}}
|
|
33
|
+
{{/work_id}}
|
|
34
|
+
{{#tags}}
|
|
35
|
+
tags:
|
|
36
|
+
{{#tags}}
|
|
37
|
+
- {{.}}
|
|
38
|
+
{{/tags}}
|
|
39
|
+
{{/tags}}
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
# Build: {{title}}
|
|
43
|
+
|
|
44
|
+
## Configuration
|
|
45
|
+
|
|
46
|
+
- **Tool**: {{build_tool}}
|
|
47
|
+
{{#command}}
|
|
48
|
+
- **Command**: `{{command}}`
|
|
49
|
+
{{/command}}
|
|
50
|
+
{{#repository}}
|
|
51
|
+
- **Repository**: {{repository}}
|
|
52
|
+
{{/repository}}
|
|
53
|
+
{{#branch}}
|
|
54
|
+
- **Branch**: {{branch}}
|
|
55
|
+
{{/branch}}
|
|
56
|
+
{{#commit_sha}}
|
|
57
|
+
- **Commit**: {{commit_sha}}
|
|
58
|
+
{{/commit_sha}}
|
|
59
|
+
|
|
60
|
+
## Output
|
|
61
|
+
|
|
62
|
+
```
|
|
63
|
+
{{output}}
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
{{#artifacts}}
|
|
67
|
+
## Artifacts
|
|
68
|
+
|
|
69
|
+
{{#artifacts}}
|
|
70
|
+
- {{.}}
|
|
71
|
+
{{/artifacts}}
|
|
72
|
+
{{/artifacts}}
|
|
73
|
+
|
|
74
|
+
{{#summary}}
|
|
75
|
+
## Summary
|
|
76
|
+
|
|
77
|
+
{{summary}}
|
|
78
|
+
{{/summary}}
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
# Build Log Type Definition
|
|
2
|
+
#
|
|
3
|
+
# This file defines the schema, frontmatter rules, and configuration
|
|
4
|
+
# for build process log entries.
|
|
5
|
+
|
|
6
|
+
id: build
|
|
7
|
+
display_name: Build Log
|
|
8
|
+
description: CI/CD builds, compilation output, npm/cargo/make builds, build failures
|
|
9
|
+
|
|
10
|
+
# Output configuration
|
|
11
|
+
output_path: .fractary/logs/build
|
|
12
|
+
|
|
13
|
+
# File naming rules
|
|
14
|
+
file_naming:
|
|
15
|
+
pattern: "{date}-{build_id}.md"
|
|
16
|
+
date_format: "YYYYMMDD-HHmmss"
|
|
17
|
+
slug_source: build_id
|
|
18
|
+
slug_max_length: 36
|
|
19
|
+
|
|
20
|
+
# Frontmatter schema
|
|
21
|
+
frontmatter:
|
|
22
|
+
required_fields:
|
|
23
|
+
- log_type
|
|
24
|
+
- title
|
|
25
|
+
- build_id
|
|
26
|
+
- date
|
|
27
|
+
- status
|
|
28
|
+
optional_fields:
|
|
29
|
+
- repository
|
|
30
|
+
- branch
|
|
31
|
+
- commit_sha
|
|
32
|
+
- build_tool
|
|
33
|
+
- exit_code
|
|
34
|
+
- duration_seconds
|
|
35
|
+
- artifacts
|
|
36
|
+
- work_id
|
|
37
|
+
- tags
|
|
38
|
+
defaults:
|
|
39
|
+
log_type: build
|
|
40
|
+
status: pending
|
|
41
|
+
|
|
42
|
+
# Document structure
|
|
43
|
+
structure:
|
|
44
|
+
required_sections:
|
|
45
|
+
- Configuration
|
|
46
|
+
- Output
|
|
47
|
+
optional_sections:
|
|
48
|
+
- Artifacts
|
|
49
|
+
- Summary
|
|
50
|
+
section_order:
|
|
51
|
+
- Configuration
|
|
52
|
+
- Output
|
|
53
|
+
- Artifacts
|
|
54
|
+
- Summary
|
|
55
|
+
|
|
56
|
+
# Status workflow
|
|
57
|
+
status:
|
|
58
|
+
allowed_values:
|
|
59
|
+
- pending
|
|
60
|
+
- running
|
|
61
|
+
- success
|
|
62
|
+
- failure
|
|
63
|
+
- cancelled
|
|
64
|
+
default: pending
|
|
65
|
+
|
|
66
|
+
# Retention policy
|
|
67
|
+
retention:
|
|
68
|
+
default_local_days: 14
|
|
69
|
+
default_cloud_days: 30
|
|
70
|
+
auto_archive: true
|
|
71
|
+
cleanup_after_archive: true
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Changelog Log Standards
|
|
2
|
+
|
|
3
|
+
## Required Conventions
|
|
4
|
+
|
|
5
|
+
### 1. Versioning
|
|
6
|
+
- ALWAYS use semantic versioning (MAJOR.MINOR.PATCH)
|
|
7
|
+
- ALWAYS specify the version affected by the change
|
|
8
|
+
- ALWAYS increment version appropriately for change type
|
|
9
|
+
|
|
10
|
+
### 2. Change Types (Keep a Changelog format)
|
|
11
|
+
- **added**: New features
|
|
12
|
+
- **changed**: Changes in existing functionality
|
|
13
|
+
- **fixed**: Bug fixes
|
|
14
|
+
- **removed**: Removed features
|
|
15
|
+
- **deprecated**: Soon-to-be removed features
|
|
16
|
+
- **security**: Security vulnerability fixes
|
|
17
|
+
|
|
18
|
+
### 3. Breaking Changes
|
|
19
|
+
- ALWAYS mark breaking changes explicitly
|
|
20
|
+
- ALWAYS provide migration instructions for breaking changes
|
|
21
|
+
- ALWAYS include before/after examples for API changes
|
|
22
|
+
|
|
23
|
+
### 4. Linking
|
|
24
|
+
- ALWAYS reference related issues and PRs
|
|
25
|
+
- ALWAYS link to superseded changes if applicable
|
|
26
|
+
|
|
27
|
+
## Best Practices
|
|
28
|
+
|
|
29
|
+
- Use unique change_id format: `CHANGE-{timestamp}-{random}`
|
|
30
|
+
- Write changes from user perspective, not developer perspective
|
|
31
|
+
- Group related changes into single changelog entries
|
|
32
|
+
- Keep changelog entries permanent (historical record)
|
|
33
|
+
- Use conventional commit format for consistency
|
|
34
|
+
- Include deprecation timeline for deprecated features
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
---
|
|
2
|
+
log_type: changelog
|
|
3
|
+
title: {{title}}
|
|
4
|
+
change_id: {{change_id}}
|
|
5
|
+
date: {{date}}
|
|
6
|
+
version: {{version}}
|
|
7
|
+
change_type: {{change_type}}
|
|
8
|
+
{{#breaking}}
|
|
9
|
+
breaking: {{breaking}}
|
|
10
|
+
{{/breaking}}
|
|
11
|
+
{{#component}}
|
|
12
|
+
component: {{component}}
|
|
13
|
+
{{/component}}
|
|
14
|
+
{{#issue_number}}
|
|
15
|
+
issue_number: {{issue_number}}
|
|
16
|
+
{{/issue_number}}
|
|
17
|
+
{{#work_id}}
|
|
18
|
+
work_id: {{work_id}}
|
|
19
|
+
{{/work_id}}
|
|
20
|
+
{{#tags}}
|
|
21
|
+
tags:
|
|
22
|
+
{{#tags}}
|
|
23
|
+
- {{.}}
|
|
24
|
+
{{/tags}}
|
|
25
|
+
{{/tags}}
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
# Change: {{title}}
|
|
29
|
+
|
|
30
|
+
## Summary
|
|
31
|
+
|
|
32
|
+
{{summary}}
|
|
33
|
+
|
|
34
|
+
## Type: {{change_type}}
|
|
35
|
+
|
|
36
|
+
**Breaking Change**: {{#breaking}}Yes{{/breaking}}{{^breaking}}No{{/breaking}}
|
|
37
|
+
|
|
38
|
+
## Details
|
|
39
|
+
|
|
40
|
+
{{details}}
|
|
41
|
+
|
|
42
|
+
{{#migration}}
|
|
43
|
+
## Migration
|
|
44
|
+
|
|
45
|
+
{{migration}}
|
|
46
|
+
{{/migration}}
|
|
47
|
+
|
|
48
|
+
{{#before_after}}
|
|
49
|
+
## Before/After
|
|
50
|
+
|
|
51
|
+
**Before**:
|
|
52
|
+
```
|
|
53
|
+
{{before}}
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
**After**:
|
|
57
|
+
```
|
|
58
|
+
{{after}}
|
|
59
|
+
```
|
|
60
|
+
{{/before_after}}
|
|
61
|
+
|
|
62
|
+
{{#related}}
|
|
63
|
+
## Related
|
|
64
|
+
|
|
65
|
+
{{#issue_number}}
|
|
66
|
+
- Issue: #{{issue_number}}
|
|
67
|
+
{{/issue_number}}
|
|
68
|
+
{{#pr_number}}
|
|
69
|
+
- PR: #{{pr_number}}
|
|
70
|
+
{{/pr_number}}
|
|
71
|
+
{{/related}}
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# Changelog Log Type Definition
|
|
2
|
+
#
|
|
3
|
+
# This file defines the schema, frontmatter rules, and configuration
|
|
4
|
+
# for change tracking log entries.
|
|
5
|
+
|
|
6
|
+
id: changelog
|
|
7
|
+
display_name: Changelog Log
|
|
8
|
+
description: Version changes, feature updates, release notes, configuration changes
|
|
9
|
+
|
|
10
|
+
# Output configuration
|
|
11
|
+
output_path: .fractary/logs/changelog
|
|
12
|
+
|
|
13
|
+
# File naming rules
|
|
14
|
+
file_naming:
|
|
15
|
+
pattern: "{date}-{change_id}.md"
|
|
16
|
+
date_format: "YYYYMMDD-HHmmss"
|
|
17
|
+
slug_source: change_id
|
|
18
|
+
slug_max_length: 36
|
|
19
|
+
|
|
20
|
+
# Frontmatter schema
|
|
21
|
+
frontmatter:
|
|
22
|
+
required_fields:
|
|
23
|
+
- log_type
|
|
24
|
+
- title
|
|
25
|
+
- change_id
|
|
26
|
+
- date
|
|
27
|
+
- version
|
|
28
|
+
- change_type
|
|
29
|
+
optional_fields:
|
|
30
|
+
- breaking
|
|
31
|
+
- component
|
|
32
|
+
- issue_number
|
|
33
|
+
- work_id
|
|
34
|
+
- tags
|
|
35
|
+
defaults:
|
|
36
|
+
log_type: changelog
|
|
37
|
+
breaking: false
|
|
38
|
+
|
|
39
|
+
# Document structure
|
|
40
|
+
structure:
|
|
41
|
+
required_sections:
|
|
42
|
+
- Summary
|
|
43
|
+
- Details
|
|
44
|
+
optional_sections:
|
|
45
|
+
- Migration
|
|
46
|
+
- Before/After
|
|
47
|
+
- Related
|
|
48
|
+
section_order:
|
|
49
|
+
- Summary
|
|
50
|
+
- Type
|
|
51
|
+
- Details
|
|
52
|
+
- Migration
|
|
53
|
+
- Before/After
|
|
54
|
+
- Related
|
|
55
|
+
|
|
56
|
+
# Change type classification
|
|
57
|
+
change_type:
|
|
58
|
+
allowed_values:
|
|
59
|
+
- added
|
|
60
|
+
- changed
|
|
61
|
+
- fixed
|
|
62
|
+
- removed
|
|
63
|
+
- deprecated
|
|
64
|
+
- security
|
|
65
|
+
default: changed
|
|
66
|
+
|
|
67
|
+
# Retention policy
|
|
68
|
+
retention:
|
|
69
|
+
default_local_days: forever
|
|
70
|
+
default_cloud_days: forever
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# Debug Log Standards
|
|
2
|
+
|
|
3
|
+
## Required Conventions
|
|
4
|
+
|
|
5
|
+
### 1. Problem Documentation
|
|
6
|
+
- ALWAYS describe the problem clearly and completely
|
|
7
|
+
- ALWAYS include error messages and stack traces
|
|
8
|
+
- ALWAYS note the environment where the issue occurs
|
|
9
|
+
|
|
10
|
+
### 2. Investigation Tracking
|
|
11
|
+
- ALWAYS timestamp investigation steps
|
|
12
|
+
- ALWAYS document what was tried (even if unsuccessful)
|
|
13
|
+
- ALWAYS note hypotheses and their outcomes
|
|
14
|
+
|
|
15
|
+
### 3. Status Management
|
|
16
|
+
- ALWAYS update status as debugging progresses
|
|
17
|
+
- ALWAYS mark as resolved when root cause found and fixed
|
|
18
|
+
- ALWAYS link to related issues/PRs
|
|
19
|
+
|
|
20
|
+
### 4. Knowledge Capture
|
|
21
|
+
- ALWAYS document the root cause when identified
|
|
22
|
+
- ALWAYS include resolution steps for future reference
|
|
23
|
+
- ALWAYS note if issue might recur
|
|
24
|
+
|
|
25
|
+
## Best Practices
|
|
26
|
+
|
|
27
|
+
- Use unique debug_id format: `DEBUG-{timestamp}-{random}`
|
|
28
|
+
- Include reproduction steps when possible
|
|
29
|
+
- Attach relevant log snippets and screenshots
|
|
30
|
+
- Link to related debugging sessions
|
|
31
|
+
- Set severity based on impact (critical for production issues)
|
|
32
|
+
- Archive resolved sessions after 14 days
|
|
33
|
+
- Cross-reference with similar issues in the codebase
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
---
|
|
2
|
+
log_type: debug
|
|
3
|
+
title: {{title}}
|
|
4
|
+
debug_id: {{debug_id}}
|
|
5
|
+
date: {{date}}
|
|
6
|
+
status: {{status}}
|
|
7
|
+
{{#issue_number}}
|
|
8
|
+
issue_number: {{issue_number}}
|
|
9
|
+
{{/issue_number}}
|
|
10
|
+
{{#component}}
|
|
11
|
+
component: {{component}}
|
|
12
|
+
{{/component}}
|
|
13
|
+
{{#severity}}
|
|
14
|
+
severity: {{severity}}
|
|
15
|
+
{{/severity}}
|
|
16
|
+
{{#repository}}
|
|
17
|
+
repository: {{repository}}
|
|
18
|
+
{{/repository}}
|
|
19
|
+
{{#branch}}
|
|
20
|
+
branch: {{branch}}
|
|
21
|
+
{{/branch}}
|
|
22
|
+
{{#work_id}}
|
|
23
|
+
work_id: {{work_id}}
|
|
24
|
+
{{/work_id}}
|
|
25
|
+
{{#tags}}
|
|
26
|
+
tags:
|
|
27
|
+
{{#tags}}
|
|
28
|
+
- {{.}}
|
|
29
|
+
{{/tags}}
|
|
30
|
+
{{/tags}}
|
|
31
|
+
---
|
|
32
|
+
|
|
33
|
+
# Debug: {{title}}
|
|
34
|
+
|
|
35
|
+
## Problem Description
|
|
36
|
+
|
|
37
|
+
{{problem_description}}
|
|
38
|
+
|
|
39
|
+
## Investigation Steps
|
|
40
|
+
|
|
41
|
+
{{#investigation_steps}}
|
|
42
|
+
1. {{.}}
|
|
43
|
+
{{/investigation_steps}}
|
|
44
|
+
|
|
45
|
+
{{#findings}}
|
|
46
|
+
## Findings
|
|
47
|
+
|
|
48
|
+
{{#findings}}
|
|
49
|
+
- {{.}}
|
|
50
|
+
{{/findings}}
|
|
51
|
+
{{/findings}}
|
|
52
|
+
|
|
53
|
+
{{#root_cause}}
|
|
54
|
+
## Root Cause
|
|
55
|
+
|
|
56
|
+
{{root_cause}}
|
|
57
|
+
{{/root_cause}}
|
|
58
|
+
|
|
59
|
+
{{#resolution}}
|
|
60
|
+
## Resolution
|
|
61
|
+
|
|
62
|
+
{{resolution}}
|
|
63
|
+
{{/resolution}}
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
# Debug Log Type Definition
|
|
2
|
+
#
|
|
3
|
+
# This file defines the schema, frontmatter rules, and configuration
|
|
4
|
+
# for debug session log entries.
|
|
5
|
+
|
|
6
|
+
id: debug
|
|
7
|
+
display_name: Debug Log
|
|
8
|
+
description: Troubleshooting, bug investigation, error analysis, debugging notes
|
|
9
|
+
|
|
10
|
+
# Output configuration
|
|
11
|
+
output_path: .fractary/logs/debug
|
|
12
|
+
|
|
13
|
+
# File naming rules
|
|
14
|
+
file_naming:
|
|
15
|
+
pattern: "{date}-{debug_id}.md"
|
|
16
|
+
date_format: "YYYYMMDD-HHmmss"
|
|
17
|
+
slug_source: debug_id
|
|
18
|
+
slug_max_length: 36
|
|
19
|
+
|
|
20
|
+
# Frontmatter schema
|
|
21
|
+
frontmatter:
|
|
22
|
+
required_fields:
|
|
23
|
+
- log_type
|
|
24
|
+
- title
|
|
25
|
+
- debug_id
|
|
26
|
+
- date
|
|
27
|
+
- status
|
|
28
|
+
optional_fields:
|
|
29
|
+
- issue_number
|
|
30
|
+
- component
|
|
31
|
+
- severity
|
|
32
|
+
- repository
|
|
33
|
+
- branch
|
|
34
|
+
- work_id
|
|
35
|
+
- tags
|
|
36
|
+
defaults:
|
|
37
|
+
log_type: debug
|
|
38
|
+
status: active
|
|
39
|
+
|
|
40
|
+
# Document structure
|
|
41
|
+
structure:
|
|
42
|
+
required_sections:
|
|
43
|
+
- Problem Description
|
|
44
|
+
- Investigation Steps
|
|
45
|
+
optional_sections:
|
|
46
|
+
- Findings
|
|
47
|
+
- Root Cause
|
|
48
|
+
- Resolution
|
|
49
|
+
section_order:
|
|
50
|
+
- Problem Description
|
|
51
|
+
- Investigation Steps
|
|
52
|
+
- Findings
|
|
53
|
+
- Root Cause
|
|
54
|
+
- Resolution
|
|
55
|
+
|
|
56
|
+
# Status workflow
|
|
57
|
+
status:
|
|
58
|
+
allowed_values:
|
|
59
|
+
- active
|
|
60
|
+
- stopped
|
|
61
|
+
- resolved
|
|
62
|
+
- archived
|
|
63
|
+
default: active
|
|
64
|
+
|
|
65
|
+
# Severity levels
|
|
66
|
+
severity:
|
|
67
|
+
allowed_values:
|
|
68
|
+
- low
|
|
69
|
+
- medium
|
|
70
|
+
- high
|
|
71
|
+
- critical
|
|
72
|
+
default: medium
|
|
73
|
+
|
|
74
|
+
# Retention policy
|
|
75
|
+
retention:
|
|
76
|
+
default_local_days: 14
|
|
77
|
+
default_cloud_days: 30
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Deployment Log Standards
|
|
2
|
+
|
|
3
|
+
## Required Conventions
|
|
4
|
+
|
|
5
|
+
### 1. Identification
|
|
6
|
+
- ALWAYS include unique deployment_id
|
|
7
|
+
- ALWAYS specify target environment
|
|
8
|
+
- ALWAYS include version and commit SHA
|
|
9
|
+
|
|
10
|
+
### 2. Status Tracking
|
|
11
|
+
- ALWAYS update status as deployment progresses
|
|
12
|
+
- ALWAYS record start and end times
|
|
13
|
+
- ALWAYS calculate total duration
|
|
14
|
+
|
|
15
|
+
### 3. Verification
|
|
16
|
+
- ALWAYS include verification checklist
|
|
17
|
+
- ALWAYS document health check results
|
|
18
|
+
- ALWAYS note any manual verification steps
|
|
19
|
+
|
|
20
|
+
### 4. Rollback Documentation
|
|
21
|
+
- ALWAYS document rollback procedure before deployment
|
|
22
|
+
- ALWAYS mark status as rolled_back if reverting
|
|
23
|
+
- ALWAYS include reason for rollback
|
|
24
|
+
|
|
25
|
+
## Best Practices
|
|
26
|
+
|
|
27
|
+
- Use unique deployment_id format: `DEPLOY-{timestamp}-{random}`
|
|
28
|
+
- Include pre-deployment checklist completion
|
|
29
|
+
- Document any configuration changes
|
|
30
|
+
- Link to CI/CD pipeline run
|
|
31
|
+
- Record who approved/triggered the deployment
|
|
32
|
+
- Keep production deployment logs indefinitely
|
|
33
|
+
- Include metrics before and after deployment
|
|
34
|
+
- Document any incidents during deployment
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
---
|
|
2
|
+
log_type: deployment
|
|
3
|
+
title: {{title}}
|
|
4
|
+
deployment_id: {{deployment_id}}
|
|
5
|
+
date: {{date}}
|
|
6
|
+
status: {{status}}
|
|
7
|
+
environment: {{environment}}
|
|
8
|
+
{{#version}}
|
|
9
|
+
version: {{version}}
|
|
10
|
+
{{/version}}
|
|
11
|
+
{{#commit_sha}}
|
|
12
|
+
commit_sha: {{commit_sha}}
|
|
13
|
+
{{/commit_sha}}
|
|
14
|
+
{{#deployment_tool}}
|
|
15
|
+
deployment_tool: {{deployment_tool}}
|
|
16
|
+
{{/deployment_tool}}
|
|
17
|
+
{{#duration_seconds}}
|
|
18
|
+
duration_seconds: {{duration_seconds}}
|
|
19
|
+
{{/duration_seconds}}
|
|
20
|
+
{{#work_id}}
|
|
21
|
+
work_id: {{work_id}}
|
|
22
|
+
{{/work_id}}
|
|
23
|
+
{{#tags}}
|
|
24
|
+
tags:
|
|
25
|
+
{{#tags}}
|
|
26
|
+
- {{.}}
|
|
27
|
+
{{/tags}}
|
|
28
|
+
{{/tags}}
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
# Deployment: {{title}}
|
|
32
|
+
|
|
33
|
+
## Configuration
|
|
34
|
+
|
|
35
|
+
- **Environment**: {{environment}}
|
|
36
|
+
{{#version}}
|
|
37
|
+
- **Version**: {{version}}
|
|
38
|
+
{{/version}}
|
|
39
|
+
{{#commit_sha}}
|
|
40
|
+
- **Commit**: {{commit_sha}}
|
|
41
|
+
{{/commit_sha}}
|
|
42
|
+
{{#deployment_tool}}
|
|
43
|
+
- **Tool**: {{deployment_tool}}
|
|
44
|
+
{{/deployment_tool}}
|
|
45
|
+
|
|
46
|
+
## Deployment Steps
|
|
47
|
+
|
|
48
|
+
{{#deployment_steps}}
|
|
49
|
+
1. {{.}}
|
|
50
|
+
{{/deployment_steps}}
|
|
51
|
+
|
|
52
|
+
{{#verification}}
|
|
53
|
+
## Verification
|
|
54
|
+
|
|
55
|
+
{{#verification_checks}}
|
|
56
|
+
- [ ] {{.}}
|
|
57
|
+
{{/verification_checks}}
|
|
58
|
+
{{/verification}}
|
|
59
|
+
|
|
60
|
+
{{#summary}}
|
|
61
|
+
## Summary
|
|
62
|
+
|
|
63
|
+
{{summary}}
|
|
64
|
+
{{/summary}}
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
# Deployment Log Type Definition
|
|
2
|
+
#
|
|
3
|
+
# This file defines the schema, frontmatter rules, and configuration
|
|
4
|
+
# for deployment and release log entries.
|
|
5
|
+
|
|
6
|
+
id: deployment
|
|
7
|
+
display_name: Deployment Log
|
|
8
|
+
description: Production deploys, staging releases, rollbacks, environment updates
|
|
9
|
+
|
|
10
|
+
# Output configuration
|
|
11
|
+
output_path: .fractary/logs/deployment
|
|
12
|
+
|
|
13
|
+
# File naming rules
|
|
14
|
+
file_naming:
|
|
15
|
+
pattern: "{date}-{deployment_id}.md"
|
|
16
|
+
date_format: "YYYYMMDD-HHmmss"
|
|
17
|
+
slug_source: deployment_id
|
|
18
|
+
slug_max_length: 36
|
|
19
|
+
|
|
20
|
+
# Frontmatter schema
|
|
21
|
+
frontmatter:
|
|
22
|
+
required_fields:
|
|
23
|
+
- log_type
|
|
24
|
+
- title
|
|
25
|
+
- deployment_id
|
|
26
|
+
- date
|
|
27
|
+
- status
|
|
28
|
+
- environment
|
|
29
|
+
optional_fields:
|
|
30
|
+
- version
|
|
31
|
+
- commit_sha
|
|
32
|
+
- deployment_tool
|
|
33
|
+
- duration_seconds
|
|
34
|
+
- work_id
|
|
35
|
+
- tags
|
|
36
|
+
defaults:
|
|
37
|
+
log_type: deployment
|
|
38
|
+
status: pending
|
|
39
|
+
|
|
40
|
+
# Document structure
|
|
41
|
+
structure:
|
|
42
|
+
required_sections:
|
|
43
|
+
- Configuration
|
|
44
|
+
- Deployment Steps
|
|
45
|
+
optional_sections:
|
|
46
|
+
- Verification
|
|
47
|
+
- Summary
|
|
48
|
+
section_order:
|
|
49
|
+
- Configuration
|
|
50
|
+
- Deployment Steps
|
|
51
|
+
- Verification
|
|
52
|
+
- Summary
|
|
53
|
+
|
|
54
|
+
# Status workflow
|
|
55
|
+
status:
|
|
56
|
+
allowed_values:
|
|
57
|
+
- pending
|
|
58
|
+
- deploying
|
|
59
|
+
- success
|
|
60
|
+
- failure
|
|
61
|
+
- rolled_back
|
|
62
|
+
default: pending
|
|
63
|
+
|
|
64
|
+
# Environment classification
|
|
65
|
+
environment:
|
|
66
|
+
allowed_values:
|
|
67
|
+
- development
|
|
68
|
+
- staging
|
|
69
|
+
- production
|
|
70
|
+
- test
|
|
71
|
+
default: staging
|
|
72
|
+
|
|
73
|
+
# Retention policy
|
|
74
|
+
retention:
|
|
75
|
+
default_local_days: 30
|
|
76
|
+
default_cloud_days: forever
|