artifact-chain-assistant 0.8.0
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/.agents/plugins/marketplace.json +20 -0
- package/.claude-plugin/marketplace.json +20 -0
- package/.claude-plugin/plugin.json +11 -0
- package/.codex-plugin/plugin.json +27 -0
- package/.github/ISSUE_TEMPLATE/bug_report.yml +26 -0
- package/.github/ISSUE_TEMPLATE/feature_request.yml +19 -0
- package/.github/pull_request_template.md +14 -0
- package/.github/workflows/ci.yml +23 -0
- package/CHANGELOG.md +196 -0
- package/CODE_OF_CONDUCT.md +11 -0
- package/CONTRIBUTING.md +24 -0
- package/EXTENDED-ARTIFACT-CATALOG.md +312 -0
- package/EXTENDED-ARTIFACT-CATALOG.zh-CN.md +289 -0
- package/INSTALL.md +1340 -0
- package/LICENSE +186 -0
- package/NOTICE +18 -0
- package/README.md +426 -0
- package/README.zh-CN.md +409 -0
- package/SECURITY.md +19 -0
- package/adapters/claude/.claude-plugin/plugin.json +11 -0
- package/adapters/claude/EXTENDED-ARTIFACT-CATALOG.md +312 -0
- package/adapters/claude/EXTENDED-ARTIFACT-CATALOG.zh-CN.md +289 -0
- package/adapters/claude/INSTALL.md +1340 -0
- package/adapters/claude/agent-methods/catalog.yaml +260 -0
- package/adapters/claude/bin/version-lock-audit.sh +21 -0
- package/adapters/claude/bin/version-lock-refresh.sh +21 -0
- package/adapters/claude/commands/version-lock-audit.md +9 -0
- package/adapters/claude/commands/version-lock-refresh.md +9 -0
- package/adapters/claude/compatibility.json +9 -0
- package/adapters/claude/hooks/hooks.json +16 -0
- package/adapters/claude/hooks/version-lock-stop.mjs +77 -0
- package/adapters/claude/schemas/artifact-workflow-profile.schema.json +72 -0
- package/adapters/claude/scripts/batch-merge.mjs +276 -0
- package/adapters/claude/scripts/batch-split.mjs +184 -0
- package/adapters/claude/scripts/check-workflow-profile.mjs +64 -0
- package/adapters/claude/scripts/doctor.mjs +44 -0
- package/adapters/claude/scripts/lib/artifact-graph-runtime.mjs +189 -0
- package/adapters/claude/scripts/lib/compatibility-policy.mjs +435 -0
- package/adapters/claude/scripts/lib/inline-yaml-parser.mjs +216 -0
- package/adapters/claude/scripts/lib/method-registry-version.mjs +7 -0
- package/adapters/claude/scripts/lib/workflow-profile.mjs +645 -0
- package/adapters/claude/scripts/run-artifact-workflow.mjs +366 -0
- package/adapters/claude/skills/artifact-audit/SKILL.md +80 -0
- package/adapters/claude/skills/artifact-batch/SKILL.md +115 -0
- package/adapters/claude/skills/artifact-chain-bootstrap/SKILL.md +343 -0
- package/adapters/claude/skills/artifact-chain-maintainer/SKILL.md +167 -0
- package/adapters/claude/skills/artifact-generate/SKILL.md +89 -0
- package/adapters/claude/skills/artifact-repair/SKILL.md +124 -0
- package/adapters/claude/skills/artifact-review/SKILL.md +122 -0
- package/adapters/claude/skills/artifact-workflow-worker/SKILL.md +90 -0
- package/adapters/claude/skills/prd-feature/SKILL.md +68 -0
- package/adapters/claude/skills/prd-feature/author/SKILL.md +92 -0
- package/adapters/claude/skills/prd-feature/references/compose.md +43 -0
- package/adapters/claude/skills/prd-feature/references/inspect.md +94 -0
- package/adapters/claude/skills/prd-feature/references/validate.md +65 -0
- package/adapters/claude/skills/prd-feature/repair/SKILL.md +135 -0
- package/adapters/claude/skills/prd-feature/review/SKILL.md +134 -0
- package/adapters/claude/skills/scenario-script/SKILL.md +76 -0
- package/adapters/claude/skills/scenario-script/author/SKILL.md +111 -0
- package/adapters/claude/skills/scenario-script/references/compose.md +43 -0
- package/adapters/claude/skills/scenario-script/references/inspect.md +105 -0
- package/adapters/claude/skills/scenario-script/references/validate.md +72 -0
- package/adapters/claude/skills/scenario-script/repair/SKILL.md +135 -0
- package/adapters/claude/skills/scenario-script/review/SKILL.md +137 -0
- package/adapters/claude/skills/where-am-i/SKILL.md +233 -0
- package/adapters/claude/templates/README.md +159 -0
- package/adapters/claude/templates/core/decision/review-checklist.md +35 -0
- package/adapters/claude/templates/core/decision/starter.md +66 -0
- package/adapters/claude/templates/core/design/review-checklist.md +41 -0
- package/adapters/claude/templates/core/design/starter.md +84 -0
- package/adapters/claude/templates/core/e2e_test/review-checklist.md +43 -0
- package/adapters/claude/templates/core/e2e_test/starter.md +70 -0
- package/adapters/claude/templates/core/feature/review-checklist.md +29 -0
- package/adapters/claude/templates/core/feature/starter.md +43 -0
- package/adapters/claude/templates/core/scenario/review-checklist.md +29 -0
- package/adapters/claude/templates/core/scenario/starter.md +57 -0
- package/adapters/claude/templates/core/test/review-checklist.md +37 -0
- package/adapters/claude/templates/core/test/starter.md +70 -0
- package/adapters/claude/templates/extended/ADOPTION-GUIDE.md +263 -0
- package/adapters/claude/templates/extended/README.md +261 -0
- package/adapters/claude/templates/extended/agent/agent_skill/review-checklist.md +51 -0
- package/adapters/claude/templates/extended/agent/agent_skill/starter.md +133 -0
- package/adapters/claude/templates/extended/agent/hook_policy/review-checklist.md +58 -0
- package/adapters/claude/templates/extended/agent/hook_policy/starter.md +134 -0
- package/adapters/claude/templates/extended/agent/prompt_packet/review-checklist.md +54 -0
- package/adapters/claude/templates/extended/agent/prompt_packet/starter.md +106 -0
- package/adapters/claude/templates/extended/contracts/api_contract/review-checklist.md +43 -0
- package/adapters/claude/templates/extended/contracts/api_contract/starter.md +92 -0
- package/adapters/claude/templates/extended/contracts/batch_job_contract/review-checklist.md +82 -0
- package/adapters/claude/templates/extended/contracts/batch_job_contract/starter.md +158 -0
- package/adapters/claude/templates/extended/contracts/cli_contract/review-checklist.md +43 -0
- package/adapters/claude/templates/extended/contracts/cli_contract/starter.md +93 -0
- package/adapters/claude/templates/extended/contracts/data_contract/review-checklist.md +45 -0
- package/adapters/claude/templates/extended/contracts/data_contract/starter.md +88 -0
- package/adapters/claude/templates/extended/contracts/integration_contract/review-checklist.md +77 -0
- package/adapters/claude/templates/extended/contracts/integration_contract/starter.md +158 -0
- package/adapters/claude/templates/extended/contracts/ipc_contract/review-checklist.md +78 -0
- package/adapters/claude/templates/extended/contracts/ipc_contract/starter.md +214 -0
- package/adapters/claude/templates/extended/contracts/report_contract/review-checklist.md +61 -0
- package/adapters/claude/templates/extended/contracts/report_contract/starter.md +97 -0
- package/adapters/claude/templates/extended/contracts/ui_contract/review-checklist.md +70 -0
- package/adapters/claude/templates/extended/contracts/ui_contract/starter.md +150 -0
- package/adapters/claude/templates/extended/domain/database_migration/review-checklist.md +51 -0
- package/adapters/claude/templates/extended/domain/database_migration/starter.md +115 -0
- package/adapters/claude/templates/extended/domain/domain_model/review-checklist.md +43 -0
- package/adapters/claude/templates/extended/domain/domain_model/starter.md +83 -0
- package/adapters/claude/templates/extended/governance/oss_compliance/review-checklist.md +51 -0
- package/adapters/claude/templates/extended/governance/oss_compliance/starter.md +84 -0
- package/adapters/claude/templates/extended/governance/publish_skill/review-checklist.md +58 -0
- package/adapters/claude/templates/extended/governance/publish_skill/starter.md +172 -0
- package/adapters/claude/templates/extended/governance/release_policy/review-checklist.md +57 -0
- package/adapters/claude/templates/extended/governance/release_policy/starter.md +131 -0
- package/adapters/claude/templates/extended/ops/deployment_manifest/review-checklist.md +51 -0
- package/adapters/claude/templates/extended/ops/deployment_manifest/starter.md +117 -0
- package/adapters/claude/templates/extended/ops/migration_plan/review-checklist.md +63 -0
- package/adapters/claude/templates/extended/ops/migration_plan/starter.md +117 -0
- package/adapters/claude/templates/extended/ops/performance_budget/review-checklist.md +50 -0
- package/adapters/claude/templates/extended/ops/performance_budget/starter.md +117 -0
- package/adapters/claude/templates/extended/ops/runbook/review-checklist.md +51 -0
- package/adapters/claude/templates/extended/ops/runbook/starter.md +101 -0
- package/adapters/claude/templates/extended/ops/security_review/review-checklist.md +56 -0
- package/adapters/claude/templates/extended/ops/security_review/starter.md +125 -0
- package/adapters/codex/.codex-plugin/plugin.json +27 -0
- package/adapters/codex/EXTENDED-ARTIFACT-CATALOG.md +312 -0
- package/adapters/codex/EXTENDED-ARTIFACT-CATALOG.zh-CN.md +289 -0
- package/adapters/codex/INSTALL.md +1340 -0
- package/adapters/codex/agent-methods/catalog.yaml +260 -0
- package/adapters/codex/compatibility.json +9 -0
- package/adapters/codex/schemas/artifact-workflow-profile.schema.json +72 -0
- package/adapters/codex/scripts/batch-merge.mjs +276 -0
- package/adapters/codex/scripts/batch-split.mjs +184 -0
- package/adapters/codex/scripts/check-workflow-profile.mjs +64 -0
- package/adapters/codex/scripts/doctor.mjs +44 -0
- package/adapters/codex/scripts/lib/artifact-graph-runtime.mjs +189 -0
- package/adapters/codex/scripts/lib/compatibility-policy.mjs +435 -0
- package/adapters/codex/scripts/lib/inline-yaml-parser.mjs +216 -0
- package/adapters/codex/scripts/lib/method-registry-version.mjs +7 -0
- package/adapters/codex/scripts/lib/workflow-profile.mjs +645 -0
- package/adapters/codex/scripts/run-artifact-workflow.mjs +366 -0
- package/adapters/codex/skills/artifact-audit/SKILL.md +80 -0
- package/adapters/codex/skills/artifact-batch/SKILL.md +115 -0
- package/adapters/codex/skills/artifact-chain-bootstrap/SKILL.md +343 -0
- package/adapters/codex/skills/artifact-chain-maintainer/SKILL.md +167 -0
- package/adapters/codex/skills/artifact-generate/SKILL.md +89 -0
- package/adapters/codex/skills/artifact-repair/SKILL.md +124 -0
- package/adapters/codex/skills/artifact-review/SKILL.md +122 -0
- package/adapters/codex/skills/artifact-workflow-worker/SKILL.md +90 -0
- package/adapters/codex/skills/prd-feature/SKILL.md +68 -0
- package/adapters/codex/skills/prd-feature/author/SKILL.md +92 -0
- package/adapters/codex/skills/prd-feature/references/compose.md +43 -0
- package/adapters/codex/skills/prd-feature/references/inspect.md +94 -0
- package/adapters/codex/skills/prd-feature/references/validate.md +65 -0
- package/adapters/codex/skills/prd-feature/repair/SKILL.md +135 -0
- package/adapters/codex/skills/prd-feature/review/SKILL.md +134 -0
- package/adapters/codex/skills/scenario-script/SKILL.md +76 -0
- package/adapters/codex/skills/scenario-script/author/SKILL.md +111 -0
- package/adapters/codex/skills/scenario-script/references/compose.md +43 -0
- package/adapters/codex/skills/scenario-script/references/inspect.md +105 -0
- package/adapters/codex/skills/scenario-script/references/validate.md +72 -0
- package/adapters/codex/skills/scenario-script/repair/SKILL.md +135 -0
- package/adapters/codex/skills/scenario-script/review/SKILL.md +137 -0
- package/adapters/codex/skills/where-am-i/SKILL.md +233 -0
- package/adapters/codex/templates/README.md +159 -0
- package/adapters/codex/templates/core/decision/review-checklist.md +35 -0
- package/adapters/codex/templates/core/decision/starter.md +66 -0
- package/adapters/codex/templates/core/design/review-checklist.md +41 -0
- package/adapters/codex/templates/core/design/starter.md +84 -0
- package/adapters/codex/templates/core/e2e_test/review-checklist.md +43 -0
- package/adapters/codex/templates/core/e2e_test/starter.md +70 -0
- package/adapters/codex/templates/core/feature/review-checklist.md +29 -0
- package/adapters/codex/templates/core/feature/starter.md +43 -0
- package/adapters/codex/templates/core/scenario/review-checklist.md +29 -0
- package/adapters/codex/templates/core/scenario/starter.md +57 -0
- package/adapters/codex/templates/core/test/review-checklist.md +37 -0
- package/adapters/codex/templates/core/test/starter.md +70 -0
- package/adapters/codex/templates/extended/ADOPTION-GUIDE.md +263 -0
- package/adapters/codex/templates/extended/README.md +261 -0
- package/adapters/codex/templates/extended/agent/agent_skill/review-checklist.md +51 -0
- package/adapters/codex/templates/extended/agent/agent_skill/starter.md +133 -0
- package/adapters/codex/templates/extended/agent/hook_policy/review-checklist.md +58 -0
- package/adapters/codex/templates/extended/agent/hook_policy/starter.md +134 -0
- package/adapters/codex/templates/extended/agent/prompt_packet/review-checklist.md +54 -0
- package/adapters/codex/templates/extended/agent/prompt_packet/starter.md +106 -0
- package/adapters/codex/templates/extended/contracts/api_contract/review-checklist.md +43 -0
- package/adapters/codex/templates/extended/contracts/api_contract/starter.md +92 -0
- package/adapters/codex/templates/extended/contracts/batch_job_contract/review-checklist.md +82 -0
- package/adapters/codex/templates/extended/contracts/batch_job_contract/starter.md +158 -0
- package/adapters/codex/templates/extended/contracts/cli_contract/review-checklist.md +43 -0
- package/adapters/codex/templates/extended/contracts/cli_contract/starter.md +93 -0
- package/adapters/codex/templates/extended/contracts/data_contract/review-checklist.md +45 -0
- package/adapters/codex/templates/extended/contracts/data_contract/starter.md +88 -0
- package/adapters/codex/templates/extended/contracts/integration_contract/review-checklist.md +77 -0
- package/adapters/codex/templates/extended/contracts/integration_contract/starter.md +158 -0
- package/adapters/codex/templates/extended/contracts/ipc_contract/review-checklist.md +78 -0
- package/adapters/codex/templates/extended/contracts/ipc_contract/starter.md +214 -0
- package/adapters/codex/templates/extended/contracts/report_contract/review-checklist.md +61 -0
- package/adapters/codex/templates/extended/contracts/report_contract/starter.md +97 -0
- package/adapters/codex/templates/extended/contracts/ui_contract/review-checklist.md +70 -0
- package/adapters/codex/templates/extended/contracts/ui_contract/starter.md +150 -0
- package/adapters/codex/templates/extended/domain/database_migration/review-checklist.md +51 -0
- package/adapters/codex/templates/extended/domain/database_migration/starter.md +115 -0
- package/adapters/codex/templates/extended/domain/domain_model/review-checklist.md +43 -0
- package/adapters/codex/templates/extended/domain/domain_model/starter.md +83 -0
- package/adapters/codex/templates/extended/governance/oss_compliance/review-checklist.md +51 -0
- package/adapters/codex/templates/extended/governance/oss_compliance/starter.md +84 -0
- package/adapters/codex/templates/extended/governance/publish_skill/review-checklist.md +58 -0
- package/adapters/codex/templates/extended/governance/publish_skill/starter.md +172 -0
- package/adapters/codex/templates/extended/governance/release_policy/review-checklist.md +57 -0
- package/adapters/codex/templates/extended/governance/release_policy/starter.md +131 -0
- package/adapters/codex/templates/extended/ops/deployment_manifest/review-checklist.md +51 -0
- package/adapters/codex/templates/extended/ops/deployment_manifest/starter.md +117 -0
- package/adapters/codex/templates/extended/ops/migration_plan/review-checklist.md +63 -0
- package/adapters/codex/templates/extended/ops/migration_plan/starter.md +117 -0
- package/adapters/codex/templates/extended/ops/performance_budget/review-checklist.md +50 -0
- package/adapters/codex/templates/extended/ops/performance_budget/starter.md +117 -0
- package/adapters/codex/templates/extended/ops/runbook/review-checklist.md +51 -0
- package/adapters/codex/templates/extended/ops/runbook/starter.md +101 -0
- package/adapters/codex/templates/extended/ops/security_review/review-checklist.md +56 -0
- package/adapters/codex/templates/extended/ops/security_review/starter.md +125 -0
- package/agent-methods/catalog.yaml +260 -0
- package/compatibility.json +9 -0
- package/package.json +85 -0
- package/runtime/claude/version-lock-stop.mjs +77 -0
- package/schemas/artifact-workflow-profile.schema.json +72 -0
- package/scripts/batch-merge.mjs +276 -0
- package/scripts/batch-split.mjs +184 -0
- package/scripts/build-adapters.mjs +195 -0
- package/scripts/build-runtime-bundles.mjs +134 -0
- package/scripts/check-compatibility.mjs +19 -0
- package/scripts/check-method-registry.mjs +461 -0
- package/scripts/check-templates.mjs +348 -0
- package/scripts/check-workflow-profile.mjs +64 -0
- package/scripts/doctor.mjs +44 -0
- package/scripts/install-git-hooks.mjs +21 -0
- package/scripts/lib/artifact-graph-runtime.mjs +189 -0
- package/scripts/lib/compatibility-policy.mjs +435 -0
- package/scripts/lib/inline-yaml-parser.mjs +216 -0
- package/scripts/lib/method-registry-version.mjs +7 -0
- package/scripts/lib/workflow-profile.mjs +645 -0
- package/scripts/run-artifact-workflow.mjs +366 -0
- package/scripts/sync-skills.mjs +149 -0
- package/skills-src/artifact-audit/SKILL.md +80 -0
- package/skills-src/artifact-batch/SKILL.md +115 -0
- package/skills-src/artifact-chain-bootstrap/SKILL.md +343 -0
- package/skills-src/artifact-chain-maintainer/SKILL.md +167 -0
- package/skills-src/artifact-generate/SKILL.md +89 -0
- package/skills-src/artifact-repair/SKILL.md +124 -0
- package/skills-src/artifact-review/SKILL.md +122 -0
- package/skills-src/artifact-workflow-worker/SKILL.md +90 -0
- package/skills-src/prd-feature/SKILL.md +68 -0
- package/skills-src/prd-feature/author/SKILL.md +92 -0
- package/skills-src/prd-feature/references/compose.md +43 -0
- package/skills-src/prd-feature/references/inspect.md +94 -0
- package/skills-src/prd-feature/references/validate.md +65 -0
- package/skills-src/prd-feature/repair/SKILL.md +135 -0
- package/skills-src/prd-feature/review/SKILL.md +134 -0
- package/skills-src/scenario-script/SKILL.md +76 -0
- package/skills-src/scenario-script/author/SKILL.md +111 -0
- package/skills-src/scenario-script/references/compose.md +43 -0
- package/skills-src/scenario-script/references/inspect.md +105 -0
- package/skills-src/scenario-script/references/validate.md +72 -0
- package/skills-src/scenario-script/repair/SKILL.md +135 -0
- package/skills-src/scenario-script/review/SKILL.md +137 -0
- package/skills-src/where-am-i/SKILL.md.tpl +233 -0
- package/templates/README.md +159 -0
- package/templates/claude/marketplace.json.tpl +20 -0
- package/templates/claude/plugin.json.tpl +11 -0
- package/templates/claude/settings.json.tpl +16 -0
- package/templates/codex/marketplace.json.tpl +20 -0
- package/templates/codex/plugin.json.tpl +27 -0
- package/templates/core/decision/review-checklist.md +35 -0
- package/templates/core/decision/starter.md +66 -0
- package/templates/core/design/review-checklist.md +41 -0
- package/templates/core/design/starter.md +84 -0
- package/templates/core/e2e_test/review-checklist.md +43 -0
- package/templates/core/e2e_test/starter.md +70 -0
- package/templates/core/feature/review-checklist.md +29 -0
- package/templates/core/feature/starter.md +43 -0
- package/templates/core/scenario/review-checklist.md +29 -0
- package/templates/core/scenario/starter.md +57 -0
- package/templates/core/test/review-checklist.md +37 -0
- package/templates/core/test/starter.md +70 -0
- package/templates/extended/ADOPTION-GUIDE.md +263 -0
- package/templates/extended/README.md +261 -0
- package/templates/extended/agent/agent_skill/review-checklist.md +51 -0
- package/templates/extended/agent/agent_skill/starter.md +133 -0
- package/templates/extended/agent/hook_policy/review-checklist.md +58 -0
- package/templates/extended/agent/hook_policy/starter.md +134 -0
- package/templates/extended/agent/prompt_packet/review-checklist.md +54 -0
- package/templates/extended/agent/prompt_packet/starter.md +106 -0
- package/templates/extended/contracts/api_contract/review-checklist.md +43 -0
- package/templates/extended/contracts/api_contract/starter.md +92 -0
- package/templates/extended/contracts/batch_job_contract/review-checklist.md +82 -0
- package/templates/extended/contracts/batch_job_contract/starter.md +158 -0
- package/templates/extended/contracts/cli_contract/review-checklist.md +43 -0
- package/templates/extended/contracts/cli_contract/starter.md +93 -0
- package/templates/extended/contracts/data_contract/review-checklist.md +45 -0
- package/templates/extended/contracts/data_contract/starter.md +88 -0
- package/templates/extended/contracts/integration_contract/review-checklist.md +77 -0
- package/templates/extended/contracts/integration_contract/starter.md +158 -0
- package/templates/extended/contracts/ipc_contract/review-checklist.md +78 -0
- package/templates/extended/contracts/ipc_contract/starter.md +214 -0
- package/templates/extended/contracts/report_contract/review-checklist.md +61 -0
- package/templates/extended/contracts/report_contract/starter.md +97 -0
- package/templates/extended/contracts/ui_contract/review-checklist.md +70 -0
- package/templates/extended/contracts/ui_contract/starter.md +150 -0
- package/templates/extended/domain/database_migration/review-checklist.md +51 -0
- package/templates/extended/domain/database_migration/starter.md +115 -0
- package/templates/extended/domain/domain_model/review-checklist.md +43 -0
- package/templates/extended/domain/domain_model/starter.md +83 -0
- package/templates/extended/governance/oss_compliance/review-checklist.md +51 -0
- package/templates/extended/governance/oss_compliance/starter.md +84 -0
- package/templates/extended/governance/publish_skill/review-checklist.md +58 -0
- package/templates/extended/governance/publish_skill/starter.md +172 -0
- package/templates/extended/governance/release_policy/review-checklist.md +57 -0
- package/templates/extended/governance/release_policy/starter.md +131 -0
- package/templates/extended/ops/deployment_manifest/review-checklist.md +51 -0
- package/templates/extended/ops/deployment_manifest/starter.md +117 -0
- package/templates/extended/ops/migration_plan/review-checklist.md +63 -0
- package/templates/extended/ops/migration_plan/starter.md +117 -0
- package/templates/extended/ops/performance_budget/review-checklist.md +50 -0
- package/templates/extended/ops/performance_budget/starter.md +117 -0
- package/templates/extended/ops/runbook/review-checklist.md +51 -0
- package/templates/extended/ops/runbook/starter.md +101 -0
- package/templates/extended/ops/security_review/review-checklist.md +56 -0
- package/templates/extended/ops/security_review/starter.md +125 -0
- package/templates/git-hooks/pre-commit.sh +43 -0
- package/templates/git-hooks/pre-push.sh +22 -0
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: {RP_ID}
|
|
3
|
+
title: {发布策略标题}
|
|
4
|
+
status: draft
|
|
5
|
+
version: {版本号}
|
|
6
|
+
related_features: []
|
|
7
|
+
related_decisions: []
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# {RP_ID}: {发布策略标题}
|
|
11
|
+
|
|
12
|
+
<!-- 本模板是插件 starter 指导,项目本地模板可完全覆盖 -->
|
|
13
|
+
<!-- 插件模板是入门指导,项目本地模板是权威 -->
|
|
14
|
+
|
|
15
|
+
## 概述
|
|
16
|
+
|
|
17
|
+
{描述本发布策略的适用范围:哪些子包/产品、什么发布节奏、发布目标}
|
|
18
|
+
|
|
19
|
+
## 版本语义
|
|
20
|
+
|
|
21
|
+
- **主版本(major)**:{定义什么变更触发主版本号递增}
|
|
22
|
+
- **次版本(minor)**:{定义什么变更触发次版本号递增}
|
|
23
|
+
- **补丁版本(patch)**:{定义什么变更触发补丁版本递增}
|
|
24
|
+
- **预发布标签**:{alpha/beta/rc 使用规则}
|
|
25
|
+
|
|
26
|
+
## 发布节奏
|
|
27
|
+
|
|
28
|
+
| 类型 | 频率 | 触发条件 | 说明 |
|
|
29
|
+
|------|------|---------|------|
|
|
30
|
+
| 常规发布 | {频率} | {条件} | {说明} |
|
|
31
|
+
| 紧急发布 | {频率} | {条件} | {说明} |
|
|
32
|
+
| 预发布 | {频率} | {条件} | {说明} |
|
|
33
|
+
|
|
34
|
+
## 分支策略
|
|
35
|
+
|
|
36
|
+
- **主分支**:{main/master 及其保护规则}
|
|
37
|
+
- **发布分支**:{release 分支命名、生命周期、合并策略}
|
|
38
|
+
- **热修复分支**:{hotfix 分支命名和流程}
|
|
39
|
+
|
|
40
|
+
## 发布流程
|
|
41
|
+
|
|
42
|
+
### 1. 准备阶段
|
|
43
|
+
|
|
44
|
+
- [ ] 确认所有 CI 检查通过
|
|
45
|
+
- [ ] 确认版本锁审计通过
|
|
46
|
+
- [ ] 确认变更日志已更新
|
|
47
|
+
- [ ] 确认依赖版本兼容
|
|
48
|
+
|
|
49
|
+
### 2. 版本决策
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
# 确定版本号
|
|
53
|
+
{版本决策命令或流程}
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### 3. 构建与验证
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
# 全量构建
|
|
60
|
+
{构建命令}
|
|
61
|
+
|
|
62
|
+
# 测试验证
|
|
63
|
+
{测试命令}
|
|
64
|
+
|
|
65
|
+
# 验证命令
|
|
66
|
+
{验证命令}
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### 4. 发布执行
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
# 打标签
|
|
73
|
+
{打标签命令}
|
|
74
|
+
|
|
75
|
+
# 发布到注册中心
|
|
76
|
+
{发布命令}
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
### 5. 发布后确认
|
|
80
|
+
|
|
81
|
+
- [ ] 确认包已在注册中心可安装
|
|
82
|
+
- [ ] 确认文档已更新
|
|
83
|
+
- [ ] 确认下游项目已通知
|
|
84
|
+
|
|
85
|
+
## 变更日志规范
|
|
86
|
+
|
|
87
|
+
- 使用 {CHANGELOG 格式} 格式
|
|
88
|
+
- 每个发布版本必须包含:新增功能、修复、破坏性变更
|
|
89
|
+
- {附加的变更日志规则}
|
|
90
|
+
|
|
91
|
+
## 合规要求
|
|
92
|
+
|
|
93
|
+
- [ ] 许可证检查通过
|
|
94
|
+
- [ ] 安全扫描通过
|
|
95
|
+
- [ ] 第三方依赖审计通过(如适用)
|
|
96
|
+
- {附加合规项}
|
|
97
|
+
|
|
98
|
+
## 回滚策略
|
|
99
|
+
|
|
100
|
+
### 回滚触发条件
|
|
101
|
+
|
|
102
|
+
{描述什么情况下需要回滚发布}
|
|
103
|
+
|
|
104
|
+
### 回滚步骤
|
|
105
|
+
|
|
106
|
+
```bash
|
|
107
|
+
# 撤销发布
|
|
108
|
+
{回滚命令}
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
### 通知机制
|
|
112
|
+
|
|
113
|
+
{回滚后的通知流程}
|
|
114
|
+
|
|
115
|
+
## 适用范围
|
|
116
|
+
|
|
117
|
+
- **子包/产品**:{列出本策略覆盖的子包或产品}
|
|
118
|
+
- **排除项**:{列出不适用的情况}
|
|
119
|
+
|
|
120
|
+
## 关联制品
|
|
121
|
+
|
|
122
|
+
- 功能特性:{related_features}
|
|
123
|
+
- 决策:{related_decisions}
|
|
124
|
+
- 发布技能:{关联的 publish_skill 制品}
|
|
125
|
+
- 合规制品:{关联的 oss_compliance 制品}
|
|
126
|
+
|
|
127
|
+
## 变更日志
|
|
128
|
+
|
|
129
|
+
| 日期 | 变更 | 作者 |
|
|
130
|
+
|------|------|------|
|
|
131
|
+
| {YYYY-MM-DD} | 初始版本 | {作者} |
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# Deployment Manifest 审查清单
|
|
2
|
+
|
|
3
|
+
<!-- 本清单是插件通用基线,项目本地审查规则可覆盖 -->
|
|
4
|
+
|
|
5
|
+
## 结构完整性
|
|
6
|
+
|
|
7
|
+
- [ ] `id` 字段存在且符合项目 ID 模式(如 `DEP-{nnn}` 或环境名)
|
|
8
|
+
- [ ] `title` 清晰描述部署范围
|
|
9
|
+
- [ ] `environment` 已指定
|
|
10
|
+
- [ ] 部署信息完整
|
|
11
|
+
|
|
12
|
+
## 部署流程质量
|
|
13
|
+
|
|
14
|
+
- [ ] 前置条件明确
|
|
15
|
+
- [ ] 部署步骤可执行
|
|
16
|
+
- [ ] 验证方法可行
|
|
17
|
+
- [ ] 回滚计划完整
|
|
18
|
+
|
|
19
|
+
## 资源配置
|
|
20
|
+
|
|
21
|
+
- [ ] 资源规格合理
|
|
22
|
+
- [ ] 环境变量完整
|
|
23
|
+
- [ ] 配置与环境匹配
|
|
24
|
+
- [ ] 敏感信息已加密
|
|
25
|
+
|
|
26
|
+
## 健康检查
|
|
27
|
+
|
|
28
|
+
- [ ] 存活检查已配置
|
|
29
|
+
- [ ] 就绪检查已配置
|
|
30
|
+
- [ ] 超时设置合理
|
|
31
|
+
- [ ] 检查端点可访问
|
|
32
|
+
|
|
33
|
+
## 回滚计划
|
|
34
|
+
|
|
35
|
+
- [ ] 回滚触发条件明确
|
|
36
|
+
- [ ] 回滚步骤可执行
|
|
37
|
+
- [ ] 回滚验证方法可行
|
|
38
|
+
- [ ] 回滚影响已评估
|
|
39
|
+
|
|
40
|
+
## 监控与告警
|
|
41
|
+
|
|
42
|
+
- [ ] 关键指标已识别
|
|
43
|
+
- [ ] 告警阈值合理
|
|
44
|
+
- [ ] 告警通知配置正确
|
|
45
|
+
- [ ] 监控覆盖完整
|
|
46
|
+
|
|
47
|
+
## 追溯性
|
|
48
|
+
|
|
49
|
+
- [ ] 关联功能特性存在
|
|
50
|
+
- [ ] 关联决策存在
|
|
51
|
+
- [ ] 部署清单可追溯到版本
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: {DEP_ID}
|
|
3
|
+
title: {部署清单标题}
|
|
4
|
+
status: draft
|
|
5
|
+
environment: {prod/staging/dev}
|
|
6
|
+
related_features: []
|
|
7
|
+
related_decisions: []
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# {DEP_ID}: {部署清单标题}
|
|
11
|
+
|
|
12
|
+
<!-- 本模板是插件 starter 指导,项目本地模板可完全覆盖 -->
|
|
13
|
+
<!-- 插件模板是入门指导,项目本地模板是权威 -->
|
|
14
|
+
|
|
15
|
+
## 概述
|
|
16
|
+
|
|
17
|
+
{描述这个部署清单的适用环境、部署目标和约束}
|
|
18
|
+
|
|
19
|
+
## 部署信息
|
|
20
|
+
|
|
21
|
+
- **环境**:{environment}
|
|
22
|
+
- **版本**:{版本号}
|
|
23
|
+
- **部署时间**:{计划时间}
|
|
24
|
+
- **负责人**:{负责人}
|
|
25
|
+
|
|
26
|
+
## 前置条件
|
|
27
|
+
|
|
28
|
+
- [ ] 所有测试通过
|
|
29
|
+
- [ ] 代码审查完成
|
|
30
|
+
- [ ] 依赖服务就绪
|
|
31
|
+
- [ ] 数据库迁移完成(如适用)
|
|
32
|
+
|
|
33
|
+
## 部署步骤
|
|
34
|
+
|
|
35
|
+
### 1. 准备阶段
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
# 备份当前版本
|
|
39
|
+
{备份命令}
|
|
40
|
+
|
|
41
|
+
# 验证镜像
|
|
42
|
+
{验证命令}
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### 2. 部署阶段
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
# 更新配置
|
|
49
|
+
{配置更新命令}
|
|
50
|
+
|
|
51
|
+
# 滚动更新
|
|
52
|
+
{部署命令}
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### 3. 验证阶段
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
# 健康检查
|
|
59
|
+
{健康检查命令}
|
|
60
|
+
|
|
61
|
+
# 功能验证
|
|
62
|
+
{功能验证命令}
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
## 资源配置
|
|
66
|
+
|
|
67
|
+
| 资源 | 规格 | 数量 | 说明 |
|
|
68
|
+
|------|------|------|------|
|
|
69
|
+
| CPU | {规格} | {数量} | {说明} |
|
|
70
|
+
| 内存 | {规格} | {数量} | {说明} |
|
|
71
|
+
| 存储 | {规格} | {数量} | {说明} |
|
|
72
|
+
|
|
73
|
+
## 环境变量
|
|
74
|
+
|
|
75
|
+
| 变量 | 值 | 描述 |
|
|
76
|
+
|------|-----|------|
|
|
77
|
+
| {变量1} | {值} | {描述} |
|
|
78
|
+
| {变量2} | {值} | {描述} |
|
|
79
|
+
|
|
80
|
+
## 健康检查
|
|
81
|
+
|
|
82
|
+
| 检查项 | 端点 | 预期响应 | 超时 |
|
|
83
|
+
|--------|------|---------|------|
|
|
84
|
+
| 存活检查 | /healthz | 200 OK | 5s |
|
|
85
|
+
| 就绪检查 | /ready | 200 OK | 10s |
|
|
86
|
+
|
|
87
|
+
## 回滚计划
|
|
88
|
+
|
|
89
|
+
### 回滚触发条件
|
|
90
|
+
|
|
91
|
+
{描述什么情况下需要回滚}
|
|
92
|
+
|
|
93
|
+
### 回滚步骤
|
|
94
|
+
|
|
95
|
+
```bash
|
|
96
|
+
# 回滚到上一版本
|
|
97
|
+
{回滚命令}
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### 回滚验证
|
|
101
|
+
|
|
102
|
+
{验证回滚成功的方法}
|
|
103
|
+
|
|
104
|
+
## 监控与告警
|
|
105
|
+
|
|
106
|
+
### 关键指标
|
|
107
|
+
|
|
108
|
+
| 指标 | 阈值 | 告警方式 |
|
|
109
|
+
|------|------|---------|
|
|
110
|
+
| 错误率 | < 1% | {告警方式} |
|
|
111
|
+
| 延迟 | < 200ms | {告警方式} |
|
|
112
|
+
|
|
113
|
+
## 变更日志
|
|
114
|
+
|
|
115
|
+
| 日期 | 变更 | 作者 |
|
|
116
|
+
|------|------|------|
|
|
117
|
+
| {YYYY-MM-DD} | 初始版本 | {作者} |
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# Migration Plan 审查清单
|
|
2
|
+
|
|
3
|
+
<!-- 本清单是插件通用基线,项目本地审查规则可覆盖 -->
|
|
4
|
+
|
|
5
|
+
## 结构完整性
|
|
6
|
+
|
|
7
|
+
- [ ] `id` 字段存在且符合项目 ID 模式(如 `MPLAN-{nnn}`)
|
|
8
|
+
- [ ] `title` 清晰描述迁移范围
|
|
9
|
+
- [ ] `scope` 已明确界定
|
|
10
|
+
- [ ] 迁移策略已选择
|
|
11
|
+
|
|
12
|
+
## 阶段划分
|
|
13
|
+
|
|
14
|
+
- [ ] 阶段划分合理且相互独立
|
|
15
|
+
- [ ] 每阶段有明确目标和交付物
|
|
16
|
+
- [ ] 时间窗口现实可行
|
|
17
|
+
- [ ] 验证标准可度量
|
|
18
|
+
|
|
19
|
+
## 回滚方案
|
|
20
|
+
|
|
21
|
+
- [ ] 每个阶段有明确回滚点
|
|
22
|
+
- [ ] 回滚触发条件清晰
|
|
23
|
+
- [ ] 回滚操作具体可执行
|
|
24
|
+
- [ ] 回滚窗口已定义且合理
|
|
25
|
+
|
|
26
|
+
## 数据迁移
|
|
27
|
+
|
|
28
|
+
- [ ] 数据量已评估
|
|
29
|
+
- [ ] 迁移方式已选择
|
|
30
|
+
- [ ] 一致性保证策略已说明
|
|
31
|
+
- [ ] 数据验证方案存在
|
|
32
|
+
|
|
33
|
+
## 并行运行
|
|
34
|
+
|
|
35
|
+
- [ ] 并行运行范围已定义
|
|
36
|
+
- [ ] 数据同步方式已说明
|
|
37
|
+
- [ ] 切换标准明确
|
|
38
|
+
- [ ] 并行运行时长合理
|
|
39
|
+
|
|
40
|
+
## 风险评估
|
|
41
|
+
|
|
42
|
+
- [ ] 关键风险已识别
|
|
43
|
+
- [ ] 概率和影响已评估
|
|
44
|
+
- [ ] 缓解措施具体可行
|
|
45
|
+
- [ ] 风险升级机制存在
|
|
46
|
+
|
|
47
|
+
## 依赖管理
|
|
48
|
+
|
|
49
|
+
- [ ] 关键依赖已识别
|
|
50
|
+
- [ ] 依赖状态已跟踪
|
|
51
|
+
- [ ] 依赖风险已评估
|
|
52
|
+
|
|
53
|
+
## 沟通与验收
|
|
54
|
+
|
|
55
|
+
- [ ] 沟通计划已制定
|
|
56
|
+
- [ ] 验收标准明确可度量
|
|
57
|
+
- [ ] 利益相关方已识别
|
|
58
|
+
|
|
59
|
+
## 追溯性
|
|
60
|
+
|
|
61
|
+
- [ ] 关联功能特性存在
|
|
62
|
+
- [ ] 关联决策存在
|
|
63
|
+
- [ ] 迁移计划可追溯到业务驱动因素
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: {MPLAN_ID}
|
|
3
|
+
title: {迁移计划标题}
|
|
4
|
+
status: draft
|
|
5
|
+
scope: {迁移范围}
|
|
6
|
+
related_features: []
|
|
7
|
+
related_decisions: []
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# {MPLAN_ID}: {迁移计划标题}
|
|
11
|
+
|
|
12
|
+
<!-- 本模板是插件 starter 指导,项目本地模板可完全覆盖 -->
|
|
13
|
+
<!-- 插件模板是入门指导,项目本地模板是权威 -->
|
|
14
|
+
|
|
15
|
+
## 概述
|
|
16
|
+
|
|
17
|
+
{描述这次迁移的背景、目标、范围和预期收益}
|
|
18
|
+
|
|
19
|
+
## 迁移信息
|
|
20
|
+
|
|
21
|
+
- **迁移范围**:{scope}
|
|
22
|
+
- **源状态**:{当前系统/架构/技术栈}
|
|
23
|
+
- **目标状态**:{目标系统/架构/技术栈}
|
|
24
|
+
- **迁移策略**:大爆炸 / 渐进式 / 绞杀者模式 / 并行运行
|
|
25
|
+
- **预估工期**:{时间}
|
|
26
|
+
- **负责人**:{负责人}
|
|
27
|
+
|
|
28
|
+
## 迁移阶段
|
|
29
|
+
|
|
30
|
+
### 阶段 1:{阶段名称}
|
|
31
|
+
|
|
32
|
+
**目标**:{阶段目标}
|
|
33
|
+
|
|
34
|
+
**交付物**:
|
|
35
|
+
- [ ] {交付物 1}
|
|
36
|
+
- [ ] {交付物 2}
|
|
37
|
+
|
|
38
|
+
**时间窗口**:{开始时间} ~ {结束时间}
|
|
39
|
+
|
|
40
|
+
**验证标准**:
|
|
41
|
+
- {验证标准 1}
|
|
42
|
+
- {验证标准 2}
|
|
43
|
+
|
|
44
|
+
### 阶段 2:{阶段名称}
|
|
45
|
+
|
|
46
|
+
**目标**:{阶段目标}
|
|
47
|
+
|
|
48
|
+
**交付物**:
|
|
49
|
+
- [ ] {交付物 1}
|
|
50
|
+
- [ ] {交付物 2}
|
|
51
|
+
|
|
52
|
+
**时间窗口**:{开始时间} ~ {结束时间}
|
|
53
|
+
|
|
54
|
+
**验证标准**:
|
|
55
|
+
- {验证标准 1}
|
|
56
|
+
- {验证标准 2}
|
|
57
|
+
|
|
58
|
+
## 回滚点定义
|
|
59
|
+
|
|
60
|
+
| 阶段 | 回滚点 | 回滚触发条件 | 回滚操作 | 最大回滚窗口 |
|
|
61
|
+
|------|--------|-------------|---------|-------------|
|
|
62
|
+
| {阶段1} | {回滚点} | {条件} | {操作} | {时间} |
|
|
63
|
+
| {阶段2} | {回滚点} | {条件} | {操作} | {时间} |
|
|
64
|
+
|
|
65
|
+
## 数据迁移策略
|
|
66
|
+
|
|
67
|
+
- **数据量评估**:{数据量}
|
|
68
|
+
- **迁移方式**:全量 / 增量 / 双写
|
|
69
|
+
- **一致性保证**:{一致性策略}
|
|
70
|
+
- **验证方式**:{数据验证方法}
|
|
71
|
+
|
|
72
|
+
## 并行运行期
|
|
73
|
+
|
|
74
|
+
- **并行运行范围**:{哪些系统并行运行}
|
|
75
|
+
- **数据同步方式**:{同步策略}
|
|
76
|
+
- **切换标准**:{何时从旧系统切换到新系统}
|
|
77
|
+
- **并行运行时长**:{预估时间}
|
|
78
|
+
|
|
79
|
+
## 风险评估
|
|
80
|
+
|
|
81
|
+
| 风险 | 概率 | 影响 | 缓解措施 |
|
|
82
|
+
|------|------|------|---------|
|
|
83
|
+
| {风险1} | 高/中/低 | 高/中/低 | {措施} |
|
|
84
|
+
| {风险2} | 高/中/低 | 高/中/低 | {措施} |
|
|
85
|
+
|
|
86
|
+
## 依赖关系
|
|
87
|
+
|
|
88
|
+
| 依赖项 | 依赖类型 | 负责人 | 状态 |
|
|
89
|
+
|--------|---------|--------|------|
|
|
90
|
+
| {依赖1} | 前置条件 / 外部依赖 | {负责人} | 待就绪 / 已就绪 |
|
|
91
|
+
| {依赖2} | 前置条件 / 外部依赖 | {负责人} | 待就绪 / 已就绪 |
|
|
92
|
+
|
|
93
|
+
## 沟通计划
|
|
94
|
+
|
|
95
|
+
| 事件 | 频率 | 参与者 | 渠道 |
|
|
96
|
+
|------|------|--------|------|
|
|
97
|
+
| 进度同步 | {频率} | {参与者} | {渠道} |
|
|
98
|
+
| 风险评审 | {频率} | {参与者} | {渠道} |
|
|
99
|
+
| 里程碑汇报 | {频率} | {参与者} | {渠道} |
|
|
100
|
+
|
|
101
|
+
## 验收标准
|
|
102
|
+
|
|
103
|
+
- [ ] {验收标准 1}
|
|
104
|
+
- [ ] {验收标准 2}
|
|
105
|
+
- [ ] {验收标准 3}
|
|
106
|
+
|
|
107
|
+
## 关联制品
|
|
108
|
+
|
|
109
|
+
- 功能特性:{related_features}
|
|
110
|
+
- 决策:{related_decisions}
|
|
111
|
+
- 设计文档:{related_designs}
|
|
112
|
+
|
|
113
|
+
## 变更日志
|
|
114
|
+
|
|
115
|
+
| 日期 | 变更 | 作者 |
|
|
116
|
+
|------|------|------|
|
|
117
|
+
| {YYYY-MM-DD} | 初始版本 | {作者} |
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# Performance Budget 审查清单
|
|
2
|
+
|
|
3
|
+
<!-- 本清单是插件通用基线,项目本地审查规则可覆盖 -->
|
|
4
|
+
|
|
5
|
+
## 结构完整性
|
|
6
|
+
|
|
7
|
+
- [ ] `id` 字段存在且符合项目 ID 模式(如 `PERF-{nnn}`)
|
|
8
|
+
- [ ] `title` 清晰描述预算范围
|
|
9
|
+
- [ ] `scope` 已明确界定
|
|
10
|
+
- [ ] 基线版本已标注
|
|
11
|
+
|
|
12
|
+
## 指标定义质量
|
|
13
|
+
|
|
14
|
+
- [ ] 响应时间指标包含 P50/P95/P99
|
|
15
|
+
- [ ] 吞吐量目标合理且基于实际业务量
|
|
16
|
+
- [ ] 资源使用上限合理且基于硬件能力
|
|
17
|
+
- [ ] 错误率目标符合 SLA 要求
|
|
18
|
+
|
|
19
|
+
## 测量方法
|
|
20
|
+
|
|
21
|
+
- [ ] 测试工具和版本已指定
|
|
22
|
+
- [ ] 测试场景覆盖关键路径
|
|
23
|
+
- [ ] 并发数和数据量有代表性
|
|
24
|
+
- [ ] 测量流程可复现
|
|
25
|
+
|
|
26
|
+
## 回归检测
|
|
27
|
+
|
|
28
|
+
- [ ] 回归阈值明确
|
|
29
|
+
- [ ] CI 集成方案存在(如适用)
|
|
30
|
+
- [ ] 手动审查触发条件清晰
|
|
31
|
+
- [ ] 检测频率合理
|
|
32
|
+
|
|
33
|
+
## 基线管理
|
|
34
|
+
|
|
35
|
+
- [ ] 历史基线已记录
|
|
36
|
+
- [ ] 基线更新流程已定义
|
|
37
|
+
- [ ] 基线退化有告警机制
|
|
38
|
+
|
|
39
|
+
## 可操作性
|
|
40
|
+
|
|
41
|
+
- [ ] 超出预算时有排查指引
|
|
42
|
+
- [ ] 优化方向有建议
|
|
43
|
+
- [ ] 负责人已指定
|
|
44
|
+
- [ ] 审查周期已设定
|
|
45
|
+
|
|
46
|
+
## 追溯性
|
|
47
|
+
|
|
48
|
+
- [ ] 关联功能特性存在
|
|
49
|
+
- [ ] 关联决策存在
|
|
50
|
+
- [ ] 性能预算可追溯到业务需求
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: {PERF_ID}
|
|
3
|
+
title: {性能预算标题}
|
|
4
|
+
status: draft
|
|
5
|
+
scope: {适用范围}
|
|
6
|
+
related_features: []
|
|
7
|
+
related_decisions: []
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# {PERF_ID}: {性能预算标题}
|
|
11
|
+
|
|
12
|
+
<!-- 本模板是插件 starter 指导,项目本地模板可完全覆盖 -->
|
|
13
|
+
<!-- 插件模板是入门指导,项目本地模板是权威 -->
|
|
14
|
+
|
|
15
|
+
## 概述
|
|
16
|
+
|
|
17
|
+
{描述这个性能预算的适用范围、目标用户和业务背景}
|
|
18
|
+
|
|
19
|
+
## 预算信息
|
|
20
|
+
|
|
21
|
+
- **适用范围**:{scope}
|
|
22
|
+
- **基线版本**:{当前基线版本}
|
|
23
|
+
- **测量环境**:{测试环境描述}
|
|
24
|
+
- **负责人**:{负责人}
|
|
25
|
+
|
|
26
|
+
## 性能指标预算
|
|
27
|
+
|
|
28
|
+
### 响应时间
|
|
29
|
+
|
|
30
|
+
| 接口/操作 | P50 | P95 | P99 | 测量方法 |
|
|
31
|
+
|-----------|-----|-----|-----|---------|
|
|
32
|
+
| {接口1} | {ms} | {ms} | {ms} | {测量工具} |
|
|
33
|
+
| {接口2} | {ms} | {ms} | {ms} | {测量工具} |
|
|
34
|
+
|
|
35
|
+
### 吞吐量
|
|
36
|
+
|
|
37
|
+
| 接口/操作 | 目标 QPS | 峰值 QPS | 测量方法 |
|
|
38
|
+
|-----------|---------|---------|---------|
|
|
39
|
+
| {接口1} | {QPS} | {QPS} | {测量工具} |
|
|
40
|
+
| {接口2} | {QPS} | {QPS} | {测量工具} |
|
|
41
|
+
|
|
42
|
+
### 资源使用
|
|
43
|
+
|
|
44
|
+
| 资源 | 基线 | 预算上限 | 告警阈值 | 测量方法 |
|
|
45
|
+
|------|------|---------|---------|---------|
|
|
46
|
+
| CPU | {百分比} | {百分比} | {百分比} | {监控工具} |
|
|
47
|
+
| 内存 | {MB} | {MB} | {MB} | {监控工具} |
|
|
48
|
+
| 磁盘 IO | {MB/s} | {MB/s} | {MB/s} | {监控工具} |
|
|
49
|
+
| 网络 IO | {Mbps} | {Mbps} | {Mbps} | {监控工具} |
|
|
50
|
+
|
|
51
|
+
### 错误率
|
|
52
|
+
|
|
53
|
+
| 接口/操作 | 目标错误率 | 告警阈值 | 测量方法 |
|
|
54
|
+
|-----------|-----------|---------|---------|
|
|
55
|
+
| {接口1} | {百分比} | {百分比} | {测量工具} |
|
|
56
|
+
| 全局 | {百分比} | {百分比} | {测量工具} |
|
|
57
|
+
|
|
58
|
+
## 回归检测策略
|
|
59
|
+
|
|
60
|
+
### 自动化检测
|
|
61
|
+
|
|
62
|
+
- **CI 集成**:{是否在 CI 中运行性能测试}
|
|
63
|
+
- **回归阈值**:{指标退化超过多少百分比视为回归}
|
|
64
|
+
- **检测频率**:{每次提交 / 每日 / 每周}
|
|
65
|
+
|
|
66
|
+
### 手动审查触发条件
|
|
67
|
+
|
|
68
|
+
- {触发条件 1}
|
|
69
|
+
- {触发条件 2}
|
|
70
|
+
|
|
71
|
+
## 测量方法
|
|
72
|
+
|
|
73
|
+
### 测试工具
|
|
74
|
+
|
|
75
|
+
| 工具 | 用途 | 版本 |
|
|
76
|
+
|------|------|------|
|
|
77
|
+
| {工具1} | {用途} | {版本} |
|
|
78
|
+
| {工具2} | {用途} | {版本} |
|
|
79
|
+
|
|
80
|
+
### 测试场景
|
|
81
|
+
|
|
82
|
+
| 场景 | 并发数 | 持续时间 | 数据量 |
|
|
83
|
+
|------|--------|---------|--------|
|
|
84
|
+
| {场景1} | {并发数} | {时间} | {数据量} |
|
|
85
|
+
| {场景2} | {并发数} | {时间} | {数据量} |
|
|
86
|
+
|
|
87
|
+
### 测量流程
|
|
88
|
+
|
|
89
|
+
1. {步骤 1}
|
|
90
|
+
2. {步骤 2}
|
|
91
|
+
3. {步骤 3}
|
|
92
|
+
|
|
93
|
+
## 基线历史
|
|
94
|
+
|
|
95
|
+
| 日期 | 版本 | P95 延迟 | QPS | 错误率 | 备注 |
|
|
96
|
+
|------|------|---------|-----|--------|------|
|
|
97
|
+
| {YYYY-MM-DD} | {版本} | {ms} | {QPS} | {百分比} | {备注} |
|
|
98
|
+
|
|
99
|
+
## 优化指引
|
|
100
|
+
|
|
101
|
+
当指标超出预算时的排查方向:
|
|
102
|
+
|
|
103
|
+
- **延迟退化**:{排查步骤}
|
|
104
|
+
- **吞吐下降**:{排查步骤}
|
|
105
|
+
- **资源溢出**:{排查步骤}
|
|
106
|
+
|
|
107
|
+
## 关联制品
|
|
108
|
+
|
|
109
|
+
- 功能特性:{related_features}
|
|
110
|
+
- 决策:{related_decisions}
|
|
111
|
+
- 设计文档:{related_designs}
|
|
112
|
+
|
|
113
|
+
## 变更日志
|
|
114
|
+
|
|
115
|
+
| 日期 | 版本 | 变更 | 作者 |
|
|
116
|
+
|------|------|------|------|
|
|
117
|
+
| {YYYY-MM-DD} | v1 | 初始版本 | {作者} |
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# Runbook 审查清单
|
|
2
|
+
|
|
3
|
+
<!-- 本清单是插件通用基线,项目本地审查规则可覆盖 -->
|
|
4
|
+
|
|
5
|
+
## 结构完整性
|
|
6
|
+
|
|
7
|
+
- [ ] `id` 字段存在且符合项目 ID 模式(如 `RUN-{nnn}`)
|
|
8
|
+
- [ ] `title` 清晰描述运维场景
|
|
9
|
+
- [ ] 适用场景已定义
|
|
10
|
+
- [ ] 负责人已指定
|
|
11
|
+
|
|
12
|
+
## 操作流程质量
|
|
13
|
+
|
|
14
|
+
- [ ] 步骤清晰可执行
|
|
15
|
+
- [ ] 命令准确无误
|
|
16
|
+
- [ ] 预期结果明确
|
|
17
|
+
- [ ] 验证方法可行
|
|
18
|
+
|
|
19
|
+
## 告警与监控
|
|
20
|
+
|
|
21
|
+
- [ ] 关键指标已识别
|
|
22
|
+
- [ ] 告警阈值合理
|
|
23
|
+
- [ ] 告警处理步骤明确
|
|
24
|
+
- [ ] 监控覆盖完整
|
|
25
|
+
|
|
26
|
+
## 回滚流程
|
|
27
|
+
|
|
28
|
+
- [ ] 回滚触发条件明确
|
|
29
|
+
- [ ] 回滚步骤可执行
|
|
30
|
+
- [ ] 回滚验证方法可行
|
|
31
|
+
- [ ] 回滚影响已评估
|
|
32
|
+
|
|
33
|
+
## 故障排查
|
|
34
|
+
|
|
35
|
+
- [ ] 常见问题已记录
|
|
36
|
+
- [ ] 排查步骤清晰
|
|
37
|
+
- [ ] 日志位置明确
|
|
38
|
+
- [ ] 联系人信息完整
|
|
39
|
+
|
|
40
|
+
## 追溯性
|
|
41
|
+
|
|
42
|
+
- [ ] 关联功能特性存在
|
|
43
|
+
- [ ] 关联决策存在
|
|
44
|
+
- [ ] 运维手册可追溯到系统设计
|
|
45
|
+
|
|
46
|
+
## 维护性
|
|
47
|
+
|
|
48
|
+
- [ ] 手册易于更新
|
|
49
|
+
- [ ] 步骤可验证
|
|
50
|
+
- [ ] 最近执行日期已记录
|
|
51
|
+
- [ ] 审核周期已设定
|