eve-repo-upkeep

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Eve Repo Upkeep

Eve代码库维护

Keep an app repo current with Eve conventions. The checks are independent — run them in parallel when multiple areas need attention.
使应用代码库符合Eve的约定。各项检查相互独立——当多个领域需要处理时,可以并行运行它们。

When to Use

使用场景

  • After Eve platform updates or manifest schema changes
  • Before a major deploy or release
  • When onboarding a new maintainer
  • 在Eve平台更新或清单架构变更后
  • 在重大部署或发布前
  • 在新维护人员入职时

Phase 1: Assess

阶段1:评估

Quickly determine which areas need attention. Check which of these files exist and whether they look stale — don't deep-read every file, just note which areas need work:
  • .eve/manifest.yaml
    — does it exist? Is the schema line
    eve/compose/v1
    ?
  • skills.txt
    — does it exist? Are there pinned or obsolete entries?
  • AGENTS.md
    /
    CLAUDE.md
    — do they reference current skills?
  • agents/
    directory — do
    agents.yaml
    ,
    teams.yaml
    ,
    chat.yaml
    exist?
  • Codebase — any obvious deprecated CLI patterns or inline secrets?
If only one area needs work, handle it directly. Otherwise, proceed to Phase 2.
快速确定哪些领域需要处理。检查以下文件是否存在,以及是否看起来过时——无需深入阅读每个文件,只需记录哪些领域需要改进:
  • .eve/manifest.yaml
    —— 是否存在?架构行是否为
    eve/compose/v1
  • skills.txt
    —— 是否存在?是否有固定版本或已废弃的条目?
  • AGENTS.md
    /
    CLAUDE.md
    —— 是否引用了当前的skills?
  • agents/
    目录 —— 是否存在
    agents.yaml
    teams.yaml
    chat.yaml
  • 代码库 —— 是否有明显已废弃的CLI模式或内嵌密钥?
如果只有一个领域需要处理,直接解决即可。否则,进入阶段2。

Phase 2: Dispatch Workers

阶段2:分配任务

Create one worker per area that needs updating. Each worker description below is self-contained — a worker can execute its area independently without context from the others.
为每个需要更新的领域创建一个任务执行者。以下每个任务执行者的描述都是独立的——执行者可以独立执行其负责领域的工作,无需其他领域的上下文。

Worker: Manifest Alignment

任务执行者:清单对齐

Check and fix
.eve/manifest.yaml
:
  • Ensure
    schema: eve/compose/v1
    is present.
  • Prefer
    services:
    over legacy
    components:
    .
  • Keep
    x-eve
    ingress and pipeline definitions accurate.
  • Keep
    x-eve.defaults
    in sync with harness defaults (harness/profile/options).
  • Keep
    x-eve.agents
    profiles aligned with orchestration policy.
  • Ensure
    x-eve.agents.config_path
    and
    x-eve.chat.config_path
    point to valid files.
  • Confirm
    ${secret.KEY}
    usage for secrets.
  • Deploy pipelines should include a
    build
    step before
    release
    .
  • Services with Docker images should have
    build.context
    defined.
  • Registry auth secrets (
    REGISTRY_USERNAME
    +
    REGISTRY_PASSWORD
    ) are required only for custom BYO registries.
检查并修复
.eve/manifest.yaml
  • 确保存在
    schema: eve/compose/v1
  • 优先使用
    services:
    而非旧版
    components:
  • 保持
    x-eve
    入口和流水线定义准确。
  • 保持
    x-eve.defaults
    与harness默认值(harness/profile/options)同步。
  • 保持
    x-eve.agents
    配置文件与编排策略一致。
  • 确保
    x-eve.agents.config_path
    x-eve.chat.config_path
    指向有效文件。
  • 确认使用
    ${secret.KEY}
    来管理密钥。
  • 部署流水线应在
    release
    步骤前包含
    build
    步骤。
  • 使用Docker镜像的服务应定义
    build.context
  • 仅对于自定义BYO注册表,才需要注册表认证密钥(
    REGISTRY_USERNAME
    +
    REGISTRY_PASSWORD
    )。

Worker: Skills File

任务执行者:Skills文件

Check and fix
skills.txt
:
  • Keep Eve skillpack references up to date.
  • Remove obsolete packs or pinned versions.
检查并修复
skills.txt
  • 保持Eve skillpack引用为最新版本。
  • 删除已废弃的包或固定版本。

Worker: Agent Instructions

任务执行者:Agent说明文档

Check and fix
AGENTS.md
,
CLAUDE.md
, and
agents/
config files:
  • Update skill references to include
    eve-se-index
    .
  • Remove stale commands or URLs.
  • agents/agents.yaml
    defines agents and skills — verify entries are current.
  • agents/teams.yaml
    defines team composition and dispatch — verify structure.
  • agents/chat.yaml
    defines chat routing rules and permissions — verify rules.
检查并修复
AGENTS.md
CLAUDE.md
以及
agents/
目录下的配置文件:
  • 更新skill引用,使其包含
    eve-se-index
  • 删除过时的命令或URL。
  • agents/agents.yaml
    定义了agents和skills——验证条目是否为最新。
  • agents/teams.yaml
    定义了团队组成和调度——验证结构是否正确。
  • agents/chat.yaml
    定义了聊天路由规则和权限——验证规则是否正确。

Worker: Deprecated Patterns

任务执行者:已废弃模式

Search the codebase for deprecated patterns and fix or flag them:
  • Old CLI commands (
    eve deploy
    vs
    eve env deploy
    )
  • Old deploy syntax without
    --ref
    parameter
  • Hardcoded domains in docs or manifests
  • Inline secrets in repo files
  • Dockerfiles missing
    org.opencontainers.image.source
    label pointing to the repo URL
  • Pipelines missing
    build
    step before
    release
  • Services with Docker images but no
    build.context
    configuration
  • Missing registry authentication secrets for custom registries (
    REGISTRY_USERNAME
    ,
    REGISTRY_PASSWORD
    or provider-equivalent names)
在代码库中搜索已废弃的模式,并修复或标记它们:
  • 旧版CLI命令(
    eve deploy
    vs
    eve env deploy
  • 缺少
    --ref
    参数的旧版部署语法
  • 文档或清单中的硬编码域名
  • 代码库文件中的内嵌密钥
  • 缺少指向代码库URL的
    org.opencontainers.image.source
    标签的Dockerfile
  • release
    步骤前缺少
    build
    步骤的流水线
  • 使用Docker镜像但未配置
    build.context
    的服务
  • 自定义注册表缺少认证密钥(
    REGISTRY_USERNAME
    REGISTRY_PASSWORD
    或提供商等效名称)

Phase 3: Verify

阶段3:验证

After all workers complete, run final verification:
bash
undefined
所有任务执行者完成工作后,运行最终验证:
bash
undefined

Local validation (Docker Compose)

本地验证(Docker Compose)

docker compose up --build
docker compose up --build

Staging deploy (requires --ref with 40-char SHA or a ref resolved against --repo-dir)

预发布环境部署(需要40字符SHA的--ref,或针对--repo-dir解析的引用)

eve env deploy staging --ref main --repo-dir .
eve env deploy staging --ref main --repo-dir .

Use --direct to bypass pipeline if needed

如有需要,使用--direct绕过流水线

eve env deploy staging --ref main --repo-dir . --direct

Track the deploy job with `eve job follow`.
eve env deploy staging --ref main --repo-dir . --direct

使用`eve job follow`跟踪部署任务。