スキル一覧に戻る
baglett

deployment-sync

by baglett

0🍴 0📅 2026年1月21日
GitHubで見るManusで実行

SKILL.md


name: deployment-sync description: Verify deployment documentation is in sync with configuration files. Use when checking documentation consistency, verifying ports match, auditing deployment config, or when user asks "check docs", "sync documentation", "verify deployment", or "audit config". allowed-tools: Read, Grep, Glob user-invocable: true

Deployment Documentation Sync

This skill verifies that deployment documentation stays in sync with actual configuration files.

Files to Cross-Reference

Source of TruthDocumentation
docker-compose.ymlDOCUMENTATION/DEPLOYMENT.md
JenkinsfileDOCUMENTATION/DEPLOYMENT.md
.env.exampleDOCUMENTATION/DEPLOYMENT.md

Verification Steps

1. Port Configuration

Extract ports from each source and compare:

From docker-compose.yml:

# Look for "ports:" sections
grep -A1 "ports:" docker-compose.yml

From Jenkinsfile:

# Look for PORT variables
grep "_PORT = " Jenkinsfile

From DOCUMENTATION/DEPLOYMENT.md:

  • Check "Port Configuration" tables
  • Verify Production and Development ports match

2. Container Names

From docker-compose.yml:

grep "container_name:" docker-compose.yml

From Jenkinsfile:

grep "_CONTAINER = " Jenkinsfile

From DOCUMENTATION/DEPLOYMENT.md:

  • Check "Container Reference" tables

3. Environment Variables

From .env.example:

grep "^[A-Z].*=" .env.example | cut -d= -f1

From DOCUMENTATION/DEPLOYMENT.md:

  • Check "Environment Variables" sections
  • Verify all variables are documented

4. Service Health Endpoints

From Jenkinsfile:

grep "curl.*health" Jenkinsfile

From DOCUMENTATION/DEPLOYMENT.md:

  • Check "Infrastructure Endpoints" table
  • Check "Quick Reference - Health Checks" section

Report Format

Generate a report listing:

  1. Ports - Any mismatches between files
  2. Containers - Missing or extra container names
  3. Environment Variables - Undocumented variables
  4. Health Endpoints - Missing health check documentation

Example Output

## Deployment Sync Report

### Ports
✅ Backend: 8000 (consistent across all files)
✅ Telegram MCP: 8081 (consistent)
⚠️ GitHub MCP: 8083 in Jenkinsfile, missing from docker-compose.yml

### Containers
✅ All 7 containers documented

### Environment Variables
⚠️ NEW_VAR in .env.example not documented in DEPLOYMENT.md

### Health Endpoints
✅ All endpoints documented

Common Issues

IssueFix
Port mismatchUpdate DEPLOYMENT.md to match Jenkinsfile
Missing containerAdd to Container Reference table
Undocumented env varAdd to Environment Variables section
Missing health endpointAdd to Infrastructure Endpoints table

Automation

For automated checking, look for patterns:

# Ports should match this pattern in each file:
# docker-compose.yml: "- 808X:808X"
# Jenkinsfile: "_PORT = '808X'"
# DEPLOYMENT.md: "| Service | 808X | 808X |"

After Fixing

When documentation is updated:

  1. Update the Changelog table in DEPLOYMENT.md
  2. Commit with message: "docs: sync deployment documentation"

スコア

総合スコア

50/100

リポジトリの品質指標に基づく評価

SKILL.md

SKILL.mdファイルが含まれている

+20
LICENSE

ライセンスが設定されている

0/10
説明文

100文字以上の説明がある

0/10
人気

GitHub Stars 100以上

0/15
最近の活動

3ヶ月以内に更新がある

0/10
フォーク

10回以上フォークされている

0/5
Issue管理

オープンIssueが50未満

+5
言語

プログラミング言語が設定されている

+5
タグ

1つ以上のタグが設定されている

0/5

レビュー

💬

レビュー機能は近日公開予定です