跳到主要内容

仓库配置清单

本清单用于配置那些无法完全通过仓库内文件完成的 GitHub 设置。

About（仓库信息）区域​

  • Description（描述）：Self-hosted enterprise AI workspace and governance platform
  • Website（网站）：https://www.open-ace.com
  • Docs（文档）：https://open-ace.github.io/open-ace-docs/docs/intro
  • Docs repository（文档仓库）：https://github.com/open-ace/open-ace-docs
  • Topics（主题）：ai-governance、ai-workspace、enterprise-ai、llmops、flask、react、self-hosted、claude-code、qwen-code、codex

社区​

  • 启用 Discussions。
  • 置顶一个 “Show and tell”（展示分享）或 “Adoption stories”（采用故事）讨论。
  • 创建标签：good first issue、help wanted、documentation、first-run、deployment、security、frontend、backend。
  • 保持 5-10 个标记为 good first issue 的小型 issue。

发布（Releases）​

发布流程​

使用 scripts/release.sh 准备并发布新版本：

# Preview changes (dry-run)
./scripts/release.sh --version 1.2.0 --dry-run

# Execute release
./scripts/release.sh --version 1.2.0

该脚本会自动完成：

  1. 校验版本格式（SemVer：X.Y.Z）
  2. 更新 pyproject.toml 版本
  3. 更新 CHANGELOG.md（把 [Unreleased] 移入新版本小节）
  4. 创建 git 提交和标签
  5. 将标签推送到 origin

标签推送之后，使用 CHANGELOG 内容创建 GitHub Release：

gh release create v1.2.0 --title "Open ACE v1.2.0" --notes-file release_notes.md --latest

发布节奏​

版本类型版本升级触发条件频率
Major（主版本）2.0.0架构重构、破坏性 API 变更每年 1-2 次
Minor（次版本）1.1.0 → 1.2.0新功能、显著改进每月一次（每月第一个周二）
Patch（修订版）1.1.1缺陷修复、安全补丁按需（每周或临时）

Patch 发布准则：

  • 累积 ≥3 个缺陷修复后再发布 patch
  • 安全修复可以立即发布
  • 两次 patch 发布之间间隔 ≥7 天，避免过于频繁

发布检查清单​

  • 从 Git 标签（例如 v1.1.0）发布版本。
  • Release 工作流在构建并发布 release 制品之前，会先运行 scripts/run_extended_tests.py --category critical。
  • 使用 scripts/generate_changelog.py 收集自上次发布以来的提交： 
    python3 scripts/generate_changelog.py --since v1.1.0
  • 为每个版本附上 Docker/部署说明以及简短的升级指南。
  • 保持 CHANGELOG.md 与最新 release 一致。
  • 仅在确认目标 PyPI 项目与包所有权之后，才配置 PYPI_API_TOKEN。
  • 如果未配置 PYPI_API_TOKEN，release 工作流会跳过 PyPI 发布，但仍会上传 GitHub release 资产。

演示（Demo）​

  • 避免公开共享的管理员凭据。
  • 在沙箱加固之前，优先使用可重置的沙箱账户、只读示例数据或简短的引导视频。