Skip to content

Commit 39891d7

Browse files
committed
ci: 更新构建指南
1 parent b4ff996 commit 39891d7

File tree

6 files changed

+55
-36
lines changed

6 files changed

+55
-36
lines changed

docs/docs/contribution/ci.dio

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<mxfile host="65bd71144e" scale="2" border="0">
22
<diagram id="CCmktOVLaJpoyg_8QXb8" name="Page-1">
3-
<mxGraphModel dx="1292" dy="912" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
3+
<mxGraphModel dx="1014" dy="907" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
44
<root>
55
<mxCell id="0"/>
66
<mxCell id="1" parent="0"/>
@@ -13,14 +13,17 @@
1313
<mxCell id="22" style="edgeStyle=none;html=1;entryX=0;entryY=0.5;entryDx=0;entryDy=0;exitX=1;exitY=0.5;exitDx=0;exitDy=0;" parent="1" source="2" target="21" edge="1">
1414
<mxGeometry relative="1" as="geometry"/>
1515
</mxCell>
16+
<mxCell id="26" style="edgeStyle=none;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="1" source="2" target="25">
17+
<mxGeometry relative="1" as="geometry"/>
18+
</mxCell>
1619
<mxCell id="2" value="代码更新&#10;(commit, PR)" style="rounded=0;whiteSpace=wrap;fontSize=18;labelBackgroundColor=none;" parent="1" vertex="1">
17-
<mxGeometry x="110" y="320" width="120" height="60" as="geometry"/>
20+
<mxGeometry x="110" y="260" width="120" height="60" as="geometry"/>
1821
</mxCell>
1922
<mxCell id="12" value="" style="edgeStyle=none;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;fontSize=18;labelBackgroundColor=none;" parent="1" source="4" target="11" edge="1">
2023
<mxGeometry relative="1" as="geometry"/>
2124
</mxCell>
2225
<mxCell id="4" value="构建文档" style="rounded=0;whiteSpace=wrap;fontSize=18;labelBackgroundColor=none;" parent="1" vertex="1">
23-
<mxGeometry x="280" y="260" width="120" height="60" as="geometry"/>
26+
<mxGeometry x="280" y="280" width="120" height="60" as="geometry"/>
2427
</mxCell>
2528
<mxCell id="9" value="" style="edgeStyle=none;exitX=0.5;exitY=1;exitDx=0;exitDy=0;fontSize=18;labelBackgroundColor=none;" parent="1" source="5" target="6" edge="1">
2629
<mxGeometry relative="1" as="geometry"/>
@@ -40,25 +43,28 @@
4043
<mxGeometry x="280" y="520" width="120" height="60" as="geometry"/>
4144
</mxCell>
4245
<mxCell id="11" value="发布到&#10;GitHub Pages" style="rounded=0;whiteSpace=wrap;fontSize=18;labelBackgroundColor=none;" parent="1" vertex="1">
43-
<mxGeometry x="450" y="260" width="120" height="60" as="geometry"/>
46+
<mxGeometry x="455" y="280" width="120" height="60" as="geometry"/>
4447
</mxCell>
4548
<mxCell id="20" value="" style="edgeStyle=none;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;fontSize=18;labelBackgroundColor=none;" parent="1" source="13" target="17" edge="1">
4649
<mxGeometry relative="1" as="geometry"/>
4750
</mxCell>
48-
<mxCell id="13" value="构建镜像" style="rounded=0;whiteSpace=wrap;fontSize=18;labelBackgroundColor=none;" parent="1" vertex="1">
49-
<mxGeometry x="450" y="400" width="120" height="60" as="geometry"/>
51+
<mxCell id="13" value="构建镜像&#10;(非fork的PR)" style="rounded=0;whiteSpace=wrap;fontSize=18;labelBackgroundColor=none;" parent="1" vertex="1">
52+
<mxGeometry x="450" y="400" width="130" height="60" as="geometry"/>
5053
</mxCell>
5154
<mxCell id="17" value="上传镜像到GitHub CR" style="rounded=0;whiteSpace=wrap;fontSize=18;labelBackgroundColor=none;" parent="1" vertex="1">
52-
<mxGeometry x="610" y="400" width="120" height="60" as="geometry"/>
55+
<mxGeometry x="640" y="400" width="120" height="60" as="geometry"/>
5356
</mxCell>
5457
<mxCell id="24" style="edgeStyle=none;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" parent="1" source="21" target="23" edge="1">
5558
<mxGeometry relative="1" as="geometry"/>
5659
</mxCell>
5760
<mxCell id="21" value="构建二进制文件" style="rounded=0;whiteSpace=wrap;fontSize=18;labelBackgroundColor=none;" parent="1" vertex="1">
58-
<mxGeometry x="280" y="130" width="120" height="60" as="geometry"/>
61+
<mxGeometry x="280" y="90" width="120" height="60" as="geometry"/>
5962
</mxCell>
6063
<mxCell id="23" value="上传到CI Archive/Release" style="rounded=0;whiteSpace=wrap;fontSize=18;labelBackgroundColor=none;" parent="1" vertex="1">
61-
<mxGeometry x="450" y="130" width="140" height="60" as="geometry"/>
64+
<mxGeometry x="450" y="90" width="140" height="60" as="geometry"/>
65+
</mxCell>
66+
<mxCell id="25" value="更新scow-vagrant" style="rounded=0;whiteSpace=wrap;fontSize=18;labelBackgroundColor=none;" vertex="1" parent="1">
67+
<mxGeometry x="280" y="180" width="120" height="60" as="geometry"/>
6268
</mxCell>
6369
</root>
6470
</mxGraphModel>

docs/docs/contribution/ci.png

15.4 KB
Loading

docs/docs/contribution/dev.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -193,4 +193,7 @@ pnpm devenv:stop
193193

194194
![CI流程](./ci.png)
195195

196+
注意:
197+
198+
1. 针对来自非fork项目的PR,CI不会构建镜像以及更新scow-vagrant
196199

docs/docs/contribution/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ title: 贡献指南
1111

1212
![贡献流程](process.png)
1313

14+
注意事项:
15+
16+
1. 对于来自fork的仓库的PR,仓库的CI将会对您的代码运行测试,但是不会构建镜像。为了方便您自己以及团队的测试工作,我们推荐您首先在您的仓库中,发起一个您的分支到您仓库的master分支的PR。这个过程的CI将会运行在您的仓库中,将会构建镜像并上传到您的仓库的GitHub Container Registry中,您以及我们团队可以使用这些镜像进行测试。
17+
1418
## 开源协议
1519

1620
OpenSCOW在[木兰宽松许可证,第2版 (MulanPSL-2.0)](https://www.google.com/url?sa=t&rct=j&q=&esrc=s&source=web&cd=&ved=2ahUKEwir0N_4hPuIAxUinK8BHT7XBfIQFnoECBQQAQ&url=https%3A%2F%2Fspdx.org%2Flicenses%2FMulanPSL-2.0.html&usg=AOvVaw2pyvwh8sqZpV0XmHiRXQje&opi=89978449)下开源。您贡献的代码同样会在此协议下开源。

docs/docs/contribution/process.dio

Lines changed: 33 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,92 +1,98 @@
11
<mxfile host="65bd71144e">
22
<diagram id="DShlPgOEDRtweNcWsppJ" name="Page-1">
3-
<mxGraphModel dx="1420" dy="1019" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
3+
<mxGraphModel dx="1841" dy="907" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
44
<root>
55
<mxCell id="0"/>
66
<mxCell id="1" parent="0"/>
7-
<mxCell id="6" style="edgeStyle=none;html=1;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="1" source="4" target="5">
7+
<mxCell id="6" style="edgeStyle=none;html=1;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" parent="1" source="4" target="5" edge="1">
88
<mxGeometry relative="1" as="geometry"/>
99
</mxCell>
10-
<mxCell id="4" value="" style="ellipse;fillColor=strokeColor;" vertex="1" parent="1">
11-
<mxGeometry x="50" y="260" width="30" height="30" as="geometry"/>
10+
<mxCell id="4" value="" style="ellipse;fillColor=strokeColor;" parent="1" vertex="1">
11+
<mxGeometry x="-30" y="260" width="30" height="30" as="geometry"/>
1212
</mxCell>
13-
<mxCell id="8" style="edgeStyle=none;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;" edge="1" parent="1" source="5" target="7">
13+
<mxCell id="8" style="edgeStyle=none;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;startArrow=none;" parent="1" source="35" target="7" edge="1">
1414
<mxGeometry relative="1" as="geometry"/>
1515
</mxCell>
16-
<mxCell id="5" value="阅读并接受开源协议&lt;br&gt;(您)" style="html=1;align=center;verticalAlign=top;rounded=1;absoluteArcSize=1;arcSize=10;dashed=0;" vertex="1" parent="1">
17-
<mxGeometry x="120" y="255" width="140" height="40" as="geometry"/>
16+
<mxCell id="37" style="edgeStyle=none;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="1" source="5" target="35">
17+
<mxGeometry relative="1" as="geometry"/>
18+
</mxCell>
19+
<mxCell id="5" value="阅读并接受开源协议&lt;br&gt;(您)" style="html=1;align=center;verticalAlign=top;rounded=1;absoluteArcSize=1;arcSize=10;dashed=0;" parent="1" vertex="1">
20+
<mxGeometry x="40" y="255" width="140" height="40" as="geometry"/>
1821
</mxCell>
19-
<mxCell id="13" style="edgeStyle=none;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="1" source="7" target="12">
22+
<mxCell id="13" style="edgeStyle=none;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" parent="1" source="7" target="12" edge="1">
2023
<mxGeometry relative="1" as="geometry"/>
2124
</mxCell>
22-
<mxCell id="14" value="否,或者不确定" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];" vertex="1" connectable="0" parent="13">
25+
<mxCell id="14" value="否,或者不确定" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];" parent="13" vertex="1" connectable="0">
2326
<mxGeometry x="-0.4123" y="1" relative="1" as="geometry">
2427
<mxPoint x="13" y="9" as="offset"/>
2528
</mxGeometry>
2629
</mxCell>
27-
<mxCell id="15" style="edgeStyle=none;html=1;entryX=0;entryY=0.5;entryDx=0;entryDy=0;exitX=1;exitY=0.5;exitDx=0;exitDy=0;" edge="1" parent="1" source="7" target="11">
30+
<mxCell id="15" style="edgeStyle=none;html=1;entryX=0.25;entryY=1;entryDx=0;entryDy=0;exitX=1;exitY=0.5;exitDx=0;exitDy=0;" parent="1" source="7" target="11" edge="1">
2831
<mxGeometry relative="1" as="geometry"/>
2932
</mxCell>
30-
<mxCell id="16" value="是" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];" vertex="1" connectable="0" parent="15">
33+
<mxCell id="16" value="是" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];" parent="15" vertex="1" connectable="0">
3134
<mxGeometry x="0.2856" y="-1" relative="1" as="geometry">
3235
<mxPoint x="-13" y="9" as="offset"/>
3336
</mxGeometry>
3437
</mxCell>
35-
<mxCell id="7" value="是否只是小修改?" style="rhombus;" vertex="1" parent="1">
36-
<mxGeometry x="288" y="250" width="126" height="50" as="geometry"/>
38+
<mxCell id="7" value="是否只是小修改?" style="rhombus;" parent="1" vertex="1">
39+
<mxGeometry x="340" y="250" width="126" height="50" as="geometry"/>
3740
</mxCell>
38-
<mxCell id="23" style="edgeStyle=none;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;" edge="1" parent="1" source="29" target="22">
41+
<mxCell id="23" style="edgeStyle=none;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;" parent="1" source="29" target="22" edge="1">
3942
<mxGeometry relative="1" as="geometry">
4043
<mxPoint x="820" y="190" as="sourcePoint"/>
4144
</mxGeometry>
4245
</mxCell>
43-
<mxCell id="32" value="接受修改" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];" vertex="1" connectable="0" parent="23">
46+
<mxCell id="32" value="接受修改" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];" parent="23" vertex="1" connectable="0">
4447
<mxGeometry x="-0.2866" y="1" relative="1" as="geometry">
4548
<mxPoint as="offset"/>
4649
</mxGeometry>
4750
</mxCell>
48-
<mxCell id="28" style="edgeStyle=none;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="1" source="11" target="29">
51+
<mxCell id="28" style="edgeStyle=none;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" parent="1" source="11" target="29" edge="1">
4952
<mxGeometry relative="1" as="geometry">
5053
<mxPoint x="680" y="190" as="targetPoint"/>
5154
</mxGeometry>
5255
</mxCell>
53-
<mxCell id="11" value="修改代码,创建PR&lt;br&gt;(您)" style="html=1;align=center;verticalAlign=top;rounded=1;absoluteArcSize=1;arcSize=10;dashed=0;" vertex="1" parent="1">
56+
<mxCell id="11" value="创建PR&lt;br&gt;(您)" style="html=1;align=center;verticalAlign=top;rounded=1;absoluteArcSize=1;arcSize=10;dashed=0;" parent="1" vertex="1">
5457
<mxGeometry x="470" y="170" width="140" height="40" as="geometry"/>
5558
</mxCell>
56-
<mxCell id="19" style="edgeStyle=none;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="1" source="12" target="17">
59+
<mxCell id="19" style="edgeStyle=none;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" parent="1" source="12" target="17" edge="1">
5760
<mxGeometry relative="1" as="geometry"/>
5861
</mxCell>
59-
<mxCell id="12" value="创建RFC issue&lt;br&gt;(您或者团队)" style="html=1;align=center;verticalAlign=top;rounded=1;absoluteArcSize=1;arcSize=10;dashed=0;" vertex="1" parent="1">
62+
<mxCell id="12" value="创建RFC issue&lt;br&gt;(您或者团队)" style="html=1;align=center;verticalAlign=top;rounded=1;absoluteArcSize=1;arcSize=10;dashed=0;" parent="1" vertex="1">
6063
<mxGeometry x="490" y="310" width="100" height="40" as="geometry"/>
6164
</mxCell>
62-
<mxCell id="33" style="edgeStyle=none;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="1" source="17" target="21">
65+
<mxCell id="33" style="edgeStyle=none;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" parent="1" source="17" target="21" edge="1">
6366
<mxGeometry relative="1" as="geometry"/>
6467
</mxCell>
65-
<mxCell id="17" value="讨论并确定终稿&lt;br&gt;(所有人)" style="html=1;align=center;verticalAlign=top;rounded=1;absoluteArcSize=1;arcSize=10;dashed=0;" vertex="1" parent="1">
68+
<mxCell id="17" value="讨论并确定终稿&lt;br&gt;(所有人)" style="html=1;align=center;verticalAlign=top;rounded=1;absoluteArcSize=1;arcSize=10;dashed=0;" parent="1" vertex="1">
6669
<mxGeometry x="620" y="310" width="110" height="40" as="geometry"/>
6770
</mxCell>
68-
<mxCell id="24" style="edgeStyle=none;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;" edge="1" parent="1" source="21">
71+
<mxCell id="24" style="edgeStyle=none;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;" parent="1" source="21" edge="1">
6972
<mxGeometry relative="1" as="geometry">
7073
<mxPoint x="910" y="260" as="targetPoint"/>
7174
</mxGeometry>
7275
</mxCell>
73-
<mxCell id="21" value="根据终稿实现&lt;br&gt;(您或者团队)" style="html=1;align=center;verticalAlign=top;rounded=1;absoluteArcSize=1;arcSize=10;dashed=0;" vertex="1" parent="1">
76+
<mxCell id="21" value="根据终稿实现&lt;br&gt;(您或者团队)" style="html=1;align=center;verticalAlign=top;rounded=1;absoluteArcSize=1;arcSize=10;dashed=0;" parent="1" vertex="1">
7477
<mxGeometry x="750" y="310" width="110" height="40" as="geometry"/>
7578
</mxCell>
76-
<mxCell id="22" value="" style="shape=sumEllipse;perimeter=ellipsePerimeter;whiteSpace=wrap;html=1;backgroundOutline=1;" vertex="1" parent="1">
79+
<mxCell id="22" value="" style="shape=sumEllipse;perimeter=ellipsePerimeter;whiteSpace=wrap;html=1;backgroundOutline=1;" parent="1" vertex="1">
7780
<mxGeometry x="910" y="240" width="30" height="30" as="geometry"/>
7881
</mxCell>
79-
<mxCell id="30" style="edgeStyle=none;html=1;exitX=0.5;exitY=1;exitDx=0;exitDy=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="1" source="29" target="12">
82+
<mxCell id="30" style="edgeStyle=none;html=1;exitX=0.5;exitY=1;exitDx=0;exitDy=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" parent="1" source="29" target="12" edge="1">
8083
<mxGeometry relative="1" as="geometry"/>
8184
</mxCell>
82-
<mxCell id="31" value="团队认为修改较大" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];" vertex="1" connectable="0" parent="30">
85+
<mxCell id="31" value="团队认为修改较大" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];" parent="30" vertex="1" connectable="0">
8386
<mxGeometry x="-0.0706" y="-1" relative="1" as="geometry">
8487
<mxPoint y="1" as="offset"/>
8588
</mxGeometry>
8689
</mxCell>
87-
<mxCell id="29" value="审核(团队)" style="rhombus;" vertex="1" parent="1">
90+
<mxCell id="29" value="审核(团队)" style="rhombus;" parent="1" vertex="1">
8891
<mxGeometry x="700" y="166.25" width="120" height="47.5" as="geometry"/>
8992
</mxCell>
93+
<mxCell id="35" value="fork仓库,进行修改&lt;br&gt;(您)" style="html=1;align=center;verticalAlign=top;rounded=1;absoluteArcSize=1;arcSize=10;dashed=0;" vertex="1" parent="1">
94+
<mxGeometry x="200" y="255" width="120" height="40" as="geometry"/>
95+
</mxCell>
9096
</root>
9197
</mxGraphModel>
9298
</diagram>

docs/docs/contribution/process.png

1.02 KB
Loading

0 commit comments

Comments
 (0)