Skip to content

Commit 4cb17c7

Browse files
honghuangdchonghuangdc
committed
ci(projects): add github actions config
1 parent 46b6156 commit 4cb17c7

File tree

5 files changed

+252
-0
lines changed

5 files changed

+252
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.yaml‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
name: Bug提交
2+
description: 在使用软件或功能的过程中遇到了错误
3+
title: '[Bug]: '
4+
labels: [ "bug?" ]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
## 请按照以下要求进行提交
11+
### 1. 提交后需要指定标签和截止时间。
12+
---
13+
14+
- type: markdown
15+
attributes:
16+
value: |
17+
## 环境信息
18+
请根据实际使用环境修改以下信息。
19+
20+
- type: input
21+
id: env-program-ver
22+
attributes:
23+
label: 软件版本
24+
validations:
25+
required: true
26+
27+
- type: dropdown
28+
id: env-vm-ver
29+
attributes:
30+
label: 运行环境
31+
description: 选择运行软件的系统版本
32+
options:
33+
- Windows (64)
34+
- Windows (32/x84)
35+
- MacOS
36+
- Linux
37+
- Ubuntu
38+
- CentOS
39+
- ArchLinux
40+
- UNIX (Android)
41+
- 其它（请在下方说明）
42+
validations:
43+
required: true
44+
45+
- type: dropdown
46+
id: env-vm-arch
47+
attributes:
48+
label: 运行架构
49+
description: (可选) 选择运行软件的系统架构
50+
options:
51+
- AMD64
52+
- x86
53+
- ARM [32] (别名：AArch32 / ARMv7）
54+
- ARM [64] (别名：AArch64 / ARMv8）
55+
- 其它
56+
57+
- type: textarea
58+
id: reproduce-steps
59+
attributes:
60+
label: 重现步骤
61+
description: |
62+
我们需要执行哪些操作才能让 bug 出现？
63+
简洁清晰的重现步骤能够帮助我们更迅速地定位问题所在。
64+
validations:
65+
required: true
66+
67+
- type: textarea
68+
id: expected
69+
attributes:
70+
label: 期望的结果是什么？
71+
validations:
72+
required: true
73+
74+
- type: textarea
75+
id: actual
76+
attributes:
77+
label: 实际的结果是什么？
78+
validations:
79+
required: true
80+
81+
- type: textarea
82+
id: logging
83+
attributes:
84+
label: 日志记录（可选）
85+
render: golang
86+
87+
- type: textarea
88+
id: extra-desc
89+
attributes:
90+
label: 补充说明（可选）

‎.github/PULL_REQUEST_TEMPLATE/pr_cn.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
首先，感谢你的贡献！ 😄
2+
3+
新特性请提交至 feature 分支，其余可提交至 main 分支。在一个维护者审核通过后合并。请确保填写以下 pull request 的信息，谢谢！~
4+
5+
[[English Template / 英文模板](./pr_en.md)]
6+
7+
### 这个变动的性质是
8+
9+
- [ ] 新特性提交
10+
- [ ] 日常 bug 修复
11+
- [ ] 站点、文档改进
12+
- [ ] 组件样式改进
13+
- [ ] TypeScript 定义更新
14+
- [ ] 重构
15+
- [ ] 代码风格优化
16+
- [ ] 分支合并
17+
- [ ] 其他改动（是关于什么的改动？）
18+
19+
### 需求背景
20+
21+
> 1. 描述相关需求的来源。
22+
> 2. 要解决的问题。
23+
> 3. 相关的 issue 讨论链接。
24+
25+
### 实现方案和 API（非新功能可选）
26+
27+
> 1. 基本的解决思路和其他可选方案。
28+
> 2. 列出最终的 API 实现和用法。
29+
> 3. 涉及 UI/交互变动需要有截图或 GIF。
30+
31+
### 对用户的影响和可能的风险（非新功能可选）
32+
33+
> 1. 这个改动对用户端是否有影响？影响的方面有哪些？
34+
> 2. 是否有可能隐含的 break change 和其他风险？
35+
36+
### Changelog 描述（非新功能可选）
37+
38+
> 1. 英文描述
39+
> 2. 中文描述（可选）
40+
41+
### 请求合并前的自查清单
42+
43+
- [ ] 文档已补充或无须补充
44+
- [ ] 代码演示已提供或无须提供
45+
- [ ] TypeScript 定义已补充或无须补充
46+
- [ ] Changelog 已提供或无须提供
47+
48+
### 后续计划（非新功能可选）
49+
50+
> 如果这个提交后面还有相关的其他提交和跟进信息，可以写在这里。

‎.github/PULL_REQUEST_TEMPLATE/pr_en.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
First of all, thank you for your contribution! 😄
2+
3+
New feature please send pull request to feature branch, and rest to main branch. Pull request will be merged after one of collaborators approve. Please makes sure that these form are filled before submitting your pull request, thank you!
4+
5+
[[中文版模板 / Chinese template](./pr_cn.md)]
6+
7+
### This is a ...
8+
9+
- [ ] New feature
10+
- [ ] Bug fix
11+
- [ ] Site / document update
12+
- [ ] Component style update
13+
- [ ] TypeScript definition update
14+
- [ ] Refactoring
15+
- [ ] Code style optimization
16+
- [ ] Branch merge
17+
- [ ] Other (about what?)
18+
19+
### What's the background?
20+
21+
> 1. Describe the source of requirement.
22+
> 2. Resolve what problem.
23+
> 3. Related issue link.
24+
25+
### API Realization (Optional if not new feature)
26+
27+
> 1. Basic thought of solution and other optional proposal.
28+
> 2. List final API realization and usage sample.
29+
> 3. GIF or snapshot should be provided if includes UI/interactive modification.
30+
31+
### What's the effect? (Optional if not new feature)
32+
33+
> 1. Does this PR affect user? Which part will be affected?
34+
> 2. What will say in changelog?
35+
> 3. Does this PR contains potential break change or other risk?
36+
37+
### Changelog description (Optional if not new feature)
38+
39+
> 1. English description
40+
> 2. Chinese description (optional)
41+
42+
### Self Check before Merge
43+
44+
- [ ] Doc is updated/provided or not needed
45+
- [ ] Demo is updated/provided or not needed
46+
- [ ] TypeScript definition is updated/provided or not needed
47+
- [ ] Changelog is provided or not needed
48+
49+
### Additional Plan? (Optional if not new feature)
50+
51+
> If this PR related with other PR or following info. You can type here.

‎.github/workflows/linter.yml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: Lint Code
3+
4+
permissions:
5+
contents: write
6+
7+
on:
8+
pull_request:
9+
branches: [main]
10+
11+
jobs:
12+
lint:
13+
name: Lint All Code
14+
runs-on: ubuntu-latest
15+
16+
steps:
17+
- name: Checkout Code
18+
uses: actions/checkout@v3
19+
with:
20+
fetch-depth: 0
21+
22+
- name: Lint Code Base
23+
uses: github/super-linter@v4
24+
env:
25+
VALIDATE_ALL_CODEBASE: false
26+
DEFAULT_BRANCH: main
27+
# To change branch master or main
28+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
29+
FILTER_REGEX_EXCLUDE: (docs|.github)
30+
VALIDATE_MARKDOWN: false

‎.github/workflows/release.yml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Release
2+
3+
on:
4+
push:
5+
tags:
6+
- "v*"
7+
8+
jobs:
9+
release:
10+
permissions:
11+
id-token: write
12+
contents: write
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v3
16+
with:
17+
fetch-depth: 0
18+
19+
- name: Install pnpm
20+
uses: pnpm/action-setup@v2
21+
22+
- name: Set node
23+
uses: actions/setup-node@v3
24+
with:
25+
node-version: lts/*
26+
cache: pnpm
27+
registry-url: "https://registry.npmjs.org"
28+
29+
- run: npx githublogen
30+
env:
31+
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

0 commit comments

Comments
 (0)