diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml index db0b485af..ce67c2be9 100644 --- a/.github/workflows/codeql.yml +++ b/.github/workflows/codeql.yml @@ -1,12 +1,12 @@ -name: "CodeQL" +name: 'CodeQL' on: push: - branches: [ "next", "2.0", "3.x-stable", "3.5-prepare", "master" ] + branches: ['next'] pull_request: - branches: [ "next" ] + branches: ['next'] schedule: - - cron: "35 10 * * 0" + - cron: '35 10 * * 0' jobs: analyze: @@ -20,7 +20,7 @@ jobs: strategy: fail-fast: false matrix: - language: [ javascript ] + language: [javascript] steps: - name: Checkout @@ -38,4 +38,4 @@ jobs: - name: Perform CodeQL Analysis uses: github/codeql-action/analyze@v2 with: - category: "/language:${{ matrix.language }}" + category: '/language:${{ matrix.language }}' diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 72af6a8d4..920e96297 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -1,4 +1,4 @@ -name: lint +name: 🚀 Lint on: ['pull_request'] diff --git a/.github/workflows/release-notify.yml b/.github/workflows/release-notify.yml index a7ddfd26b..e02e72d0e 100644 --- a/.github/workflows/release-notify.yml +++ b/.github/workflows/release-notify.yml @@ -1,10 +1,8 @@ name: 🎉 Release Notify on: + workflow_dispatch: release: - # published: latest release 和 pre release 都会触发 - # prereleased: 只有 pre release 触发 - # released: 只有 latest release 触发 types: [published] jobs: diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 0ff32aca2..d2cc7f655 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -1,4 +1,4 @@ -name: test +name: 🚀 Test on: [pull_request] diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4ced7b258..f8538d8ac 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -131,7 +131,7 @@ This makes it easy to perform version locking. ### Fully automated semantic releases -Referring to [S2's engineering practices](https://www.yuque.com/antv/vo4vyz/vtowig#HuNvY), we use [semantic-release](https://github.com/semantic-release/semantic-release) for fully automated semantic releases. It can automatically create GitHub Releases and automatically associate the release to the corresponding issue. +Referring to [S2's engineering practices](https://www.yuque.com/antv/vo4vyz/vtowig#HuNvY), we use [changesets](https://github.com/changesets/changesets) for fully automated semantic releases. It can automatically create GitHub Releases and automatically associate the release to the corresponding issue. There are three release branches: @@ -139,7 +139,7 @@ There are three release branches: - The `beta` branch for beta releases - The `alpha` branch for the preview release -Committing a commit starting with `chore(release):` in the branch above, the push code will be released and then handed over to the CI: +Create a new branch `release` from `next`, each PR will trigger CI on `release`. We publish on `next` branch finally. ```bash git commit -m "chore(release): bump version" diff --git a/CONTRIBUTING.zh-CN.md b/CONTRIBUTING.zh-CN.md index 4f7448d58..4d9bbe3ff 100644 --- a/CONTRIBUTING.zh-CN.md +++ b/CONTRIBUTING.zh-CN.md @@ -133,15 +133,9 @@ G 使用 [pnpm workspace](https://pnpm.io/workspaces) 作为 monorepo 方案。 ### 全自动的语义化线上发布 -参考 [S2 的工程化实践](https://www.yuque.com/antv/vo4vyz/vtowig#HuNvY),我们使用了 [semantic-release](https://github.com/semantic-release/semantic-release) 进行全自动的语义化发布。它可以自动创建 GitHub Releases,并自动关联发布版本到对应 issue。 +参考 [S2 的工程化实践](https://www.yuque.com/antv/vo4vyz/vtowig#HuNvY),我们使用了 [changesets](https://github.com/changesets/changesets) 进行全自动的语义化发布。它可以自动创建 GitHub Releases。 -其中发布分支有三个: - -- `next` 分支为当前稳定发布的版本 -- `beta` 分支发布测试版 -- `alpha` 分支发布预览版 - -在以上分支提交以 `chore(release):` 开头的 commit,push 代码即完成发布,后续交给 CI 即可: +从 next 分支拉出发布分支 release。每个 release 分支上的提交都会触发 CI,更新 version。最后在 next 分支上触发 publish 流程。 ```bash git commit -m "chore(release): bump version"