Skip to content

Commit

Permalink
chore: update contributing docs [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
xiaoiver committed Jun 28, 2023
1 parent 3dde919 commit eca0e3f
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 21 deletions.
12 changes: 6 additions & 6 deletions .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -20,7 +20,7 @@ jobs:
strategy:
fail-fast: false
matrix:
language: [ javascript ]
language: [javascript]

steps:
- name: Checkout
Expand All @@ -38,4 +38,4 @@ jobs:
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v2
with:
category: "/language:${{ matrix.language }}"
category: '/language:${{ matrix.language }}'
2 changes: 1 addition & 1 deletion .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: lint
name: 🚀 Lint

on: ['pull_request']

Expand Down
4 changes: 1 addition & 3 deletions .github/workflows/release-notify.yml
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: test
name: 🚀 Test

on: [pull_request]

Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,15 +131,15 @@ 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:
- The `next` branch is for the current stable release
- 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"
Expand Down
10 changes: 2 additions & 8 deletions CONTRIBUTING.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down

0 comments on commit eca0e3f

Please sign in to comment.