基于 Github 平台的 .NET 开源项目模板. 嘎嘎实用!

╰半夏微凉° 2024-03-22 18:03 8阅读 0赞

### 定位 ###

以下5种境地的同学可以继续往下读一读:

*  你\[是\]或\[想成为\]一名.NET开源项目作者.
 *  你有一个.NET的开源项目,并在维护或迭代中.
 *  你被ISSUE/PR/CI/发布等问题所困扰.
 *  你喜欢研究 Github Action.
 *  单纯对标题感兴趣.

下面将从需求->开发->测试->发布->归档这个流程来讲, 功能的配置及原理将在后面几篇中讲解,本篇仅展现功能:

### 需求相关功能 ###

说到开源项目的需求,不得不提 ISSUE, 所以以用户反馈一个 BUG/建议/问答/期待 为起点来谈以下这款模板带来的便捷功能;

#### 1. 现成的 issue 表单模板: ####

![52909c5d34fb3e4e83c4258b32c60a9c.png][]

表单提交后会自动打上你希望归类的 Label. 比如提BUG会打上一个红色的 bug label.

#### 2. issue 推荐功能 ####

issue 被提交后, 管道将运行推荐功能, 从过往的 issue 中挑选出一定相似度的 issue 并推荐给提问者.

![2454479b799b972fe838fbd572da71da.png][]

#### 3. 垃圾 issue 屏蔽用户 ####

如果有捣乱的人开 issue 问候您的家人, 给它来个 aaa-block-user 标签, 管道运行后会拉黑他, 并自动删除当前 issue.

![36ec62b56546200d3c380427238d2bd2.png][]

### 编码相关功能 ###

#### 1. 提交 pr 自动归类, 太直观了直接看图. ####

![0abb95dc0d7cc34382e6d05db1e4e0b4.png][]

#### 2. 提交 pr 自动运行跨平台的 UT 测试, 当然了具体测什么您自己写. ####

![0abfc7f0bb0f7a2247483f3c3dcf8b95.png][]

#### 3. 推荐一定相似度的 ISSUE 给 PR, 相似度区间和推荐数量您是可以自己配置的,以后讲. ####

![cdae72190021f40f018c4cf4e9e154e3.png][]

#### 4. pr 成功合并后, 将被自动归档到 \{ProjectName\}\_VNext 计划中, 图隐藏了一些, 仅展示有用部分. ####

![448116667a79031c84867fa6e19e698f.png][]

#### 5. Src 工程自动生成全局 Using 引用. ####

![f4a720fe01b9c2ce83a26c364d5b965b.png][]

### 测试相关功能 ###

#### 和我们正规项目不一样, 实际上测试包含了两个部分: ####

*  1. 开发时测试就是上面的 PR 自动触发的测试;
 *  2. 发布时测试, 测试并上传覆盖率文件;

![1fccbe78b25d8206f51f909678ca40e4.png][]

### 发布相关功能 ###

发布前需要编辑 CHANGELOG.md (后面有篇专门介绍发布的文章会讲)

#### 1. NUGET 自动发版: ####

管道功能会根据你 CHANGELOG 的最新节点信息匹配工程节点, 然后进行自动发版并推送到 NUGET , 很具体的发版错误提示.

![7bdd80e5c6a2de882fe64ee584221feb.png][]

### 归档相关功能 ###

#### 1. 自动帮您的仓库发布 release 信息. ####

![35adab5e56da7990d819c7889f5287e2.png][]

#### 2. 自动归档当前计划,当前的 \{ProjectName\}\_VNext 变为您发布的主版本;随后会新建一个 \{ProjectName\}\_VNext 计划 ####

![dc6902d8e87bbbed5a47b124ce705024.png][]

### 其他功能 ###

#### 自动的依赖检测机器人. ####

![0983573acf2ef7b0bb8b2f939300a3a1.png][]

这 PR 给的信息是真全啊, 不展开看了.

### 学习与使用 ###

#### 1. 将[项目][Link 1] fork 到你的仓库中, 然后 Setting 作为模板. ####

![583fe633ae160564bbb7c0e42293eb54.png][]

#### 2. 文章导航 ####

*  [模板介绍][Link 2]
 *  [项目及脚本介绍][Link 3]
 *  [ISSUE 相关][ISSUE]
 *  [PR 相关][PR]
 *  [发布相关][Link 4]

[52909c5d34fb3e4e83c4258b32c60a9c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/b9f8affff7894afea9a41982dbe75c1e.png
[2454479b799b972fe838fbd572da71da.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/7a035d90edac452caef7480613556414.png
[36ec62b56546200d3c380427238d2bd2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/58c7221a34d94dd0af4b2515b4808854.png
[0abb95dc0d7cc34382e6d05db1e4e0b4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/435ebc7c25524f0b837f3387d2d8d8fb.png
[0abfc7f0bb0f7a2247483f3c3dcf8b95.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/c76df8ae23bf4061a73eb68dde5d0123.png
[cdae72190021f40f018c4cf4e9e154e3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/2a040b318ffa4976b96d4298bf344978.png
[448116667a79031c84867fa6e19e698f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/98b606db85e34d078a394b3605f46616.png
[f4a720fe01b9c2ce83a26c364d5b965b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/32177513da134abd9fae4b7e1ddd5acf.png
[1fccbe78b25d8206f51f909678ca40e4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/24a9e3480a714863a02cf59347f9c7c3.png
[7bdd80e5c6a2de882fe64ee584221feb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/3e4fce69c5374ce282fc683e0ef9fa42.png
[35adab5e56da7990d819c7889f5287e2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/4e5a27ff39c74c0d92b23832b3f7f8d1.png
[dc6902d8e87bbbed5a47b124ce705024.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/e7caed04600b4a5fb6b9dd719cb0fcad.png
[0983573acf2ef7b0bb8b2f939300a3a1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/5fa6896cbf4a4b08b40baad5a0511387.png
[Link 1]: https://github.com/night-moon-studio/Template
[583fe633ae160564bbb7c0e42293eb54.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/3f29bb19c20344b59e448b5b08e384f5.png
[Link 2]: https://www.cnblogs.com/NMSLanX/p/17326728.html
[Link 3]: https://www.cnblogs.com/NMSLanX/p/17328697.html
[ISSUE]: https://www.cnblogs.com/NMSLanX/p/17328924.html
[PR]: https://www.cnblogs.com/NMSLanX/p/17328962.html
[Link 4]: https://www.cnblogs.com/NMSLanX/p/17329521.html