Back to Details

eve-repo-upkeep

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Eve Repo Upkeep

Eve代码库维护

Use this workflow to keep an app repo current with Eve conventions.
使用此工作流使应用代码库符合Eve的最新规范。

When to Use

使用场景

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

Files to Keep Current

需要保持最新的文件

.eve/manifest.yaml

.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 (GHCR_USERNAME, GHCR_TOKEN or GITHUB_TOKEN) should be configured.
  • 确保存在
    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
    。
  • 应配置注册表认证密钥（GHCR_USERNAME、GHCR_TOKEN或GITHUB_TOKEN）。

skills.txt

skills.txt

  • Keep Eve skillpack references up to date.
  • Remove obsolete packs or pinned versions.
  • 保持Eve skillpack引用为最新版本。
  • 移除过时的包或固定版本。

Agent Instructions (AGENTS.md / CLAUDE.md)

Agent说明文档（AGENTS.md / CLAUDE.md）

  • Update skill references to include 
    eve-se-index
    .
  • Remove stale commands or URLs.
  • 更新技能引用以包含
    eve-se-index
    。
  • 移除失效的命令或URL。

Agent Config Files (
agents/
)

Agent配置文件（
agents/
）

  • agents/agents.yaml
    defines agents and skills.
  • agents/teams.yaml
    defines team composition and dispatch.
  • agents/chat.yaml
    defines chat routing rules and permissions.
  • agents/agents.yaml
    定义Agent和技能。
  • agents/teams.yaml
    定义团队组成和调度规则。
  • agents/chat.yaml
    定义聊天路由规则和权限。

Check for Deprecated Patterns

检查已弃用的模式

  • 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 (GHCR_USERNAME, GHCR_TOKEN/GITHUB_TOKEN)
  • 旧版CLI命令（
    eve deploy
    vs 
    eve env deploy
    ）
  • 不带
    --ref
    参数的旧版部署语法
  • 文档或清单中的硬编码域名
  • 代码库文件中的内嵌密钥
  • 缺少指向代码库URL的
    org.opencontainers.image.source
    标签的Dockerfile
  • release
    步骤前缺少
    build
    步骤的流水线
  • 带有Docker镜像但未配置
    build.context
    的服务
  • 缺失注册表认证密钥（GHCR_USERNAME、GHCR_TOKEN/GITHUB_TOKEN）

Test After Updates

更新后测试

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`跟踪部署任务。