0.0.0 • Published 3 months ago

revoy v0.0.0

Weekly downloads
-
License
ISC
Repository
-
Last release
3 months ago

Revoy

融合了 revision(版本更新)deploy(发布)的含义,简洁传递出“版本迭代与发布”的核心价值。

使用 changesets 基础工具结合 GitHub Actions 进行 功能分支开发beta 版本发布正式版本发布 的完整流程,适用于多人协作环境。

流程概览

  • 分支创建:
    • main 分支新建功能分支,分支名需以 patch/minor/major/ 为前缀,分别表示修复版本、次版本或主版本更新。
  • 功能开发:
    • 在功能分支上进行开发并提交代码。
  • 代码合并与发布:
    • 发起 Pull Request (PR),将功能分支合并到目标分支:
      • 合并到 develop 分支:发布 开发版(develop)npm 包,版本号带 develop 标识。
      • 合并到 beta 分支:发布 测试版(beta)npm 包,版本号带 beta 标识。
      • 合并到 main 分支:发布 正式版(stable)npm 包,版本号为正式版本。
    • 根据功能分支的前缀(patch/、minor/、major/),自动升级对应的版本号(如 1.0.1、1.1.0 或 2.0.0)。

多人协作注意事项

  • 在 PR 过程中若发现冲突,需手动将 main 分支的最新代码合并到当前功能分支,解决冲突后再继续合并流程。
  • 合并时,始终保留最高版本号,确保版本号不会因合并操作而回退。

环境变量

  • GITHUB_TOKEN:GitHub 的访问令牌(Token),用于身份验证和授权 API 请求。用于 CI/CD 访问私有仓库或执行自动化操作。
  • REPO_OWNER:仓库的所有者,可以是 GitHub 用户名(个人仓库)或组织名(组织仓库)。
  • REPO_NAME:仓库名称,即 GitHub 上的项目名称。
  • GITHUB_BEFORE_HASH:在 GitHub 触发某些事件(如 push)时,表示更改前的提交哈希(SHA)。用于比较变更内容。
  • GITHUB_AFTER_HASH:在 GitHub 触发某些事件(如 push)时,表示更改后的提交哈希(SHA)。通常用于确定最新的代码状态。
  • GITHUB_COMMIT_MESSAGE:当前提交的 Git 提交信息(commit message),用于描述本次提交的更改内容。
  • DEFAULT_MAIN_BRANCH:主分支名称,通常是 main 或 master,用于管理正式版本的代码,默认为 "main"。
  • DEFAULT_BETA_BRANCH:Beta 分支名称,通常用于预发布(beta)版本,测试即将发布的功能,默认为 "beta"。
  • DEFAULT_DEVELOP_BRANCH:开发分支名称,通常是 develop,用于日常开发,可能会合并多个 feature 分支,默认为"develop"。