MiniScaffold 0.37.1

MiniScaffold

什么是 MiniScaffold？

这是一个为创建和发布F# 模板的

• 用以创建和发布针对.NET 6.0的库（代码：net6.0）
• 用以创建和发布针对.NET 6.0的应用（代码：net6.0）

为什么使用 MiniScaffold？

这可以消除开发者创建开源项目时面临的歧义。如：

• 如何组织我的项目结构？
• 如何创建可重复的构建过程？
• 我应该使用哪个测试框架？
• 如何轻松创建发布版本？
• 应该使用哪些 Issue/Pull Request 模板？
• 应该如何创建文档？
• 如何轻松设置 CI/CD？
• 标准的 .gitignore 文件是什么？
• 还有什么其他事情可以使我在开始一个新的项目时更加容易（即使我对这些事不太了解）？

这包含哪些内容？

所有项目类型

• 标准项目结构 用于您的 dotnet 应用程序
• 构建自动化 工具通过 FAKE
• 包管理工具 通过 Paket
• 单元测试 通过 Expecto
• 代码覆盖率 通过 Altcover
  • 此外还通过 ReportGenerator 生成一个 HTML 报告
• 代码格式化 通过 Fantomas
• GitRelease 构建步骤会将最新的 CHANGELOG.md 提交到仓库体中，并创建一个 git tag。
  • 如果您在 CHANGELOG.md 中引用 拉取请求，它将 更新那个拉取请求 并记录所发布的版本。
• GitHubRelease 构建步骤将通过 GitHub 发布 来自 CHANGELOG.md 的信息，并添加任何整理好的资源（如 nuget/zip/targz 等）。
• 通过 持续集成 使用 GitHub Actions

针对 库

• 为 net6.0 编译 - 目标框架
  • 为了为 net6.0 编译，需要安装 .NET 6.0
• Sourcelink，通过将源控制元数据添加到构建资产，为您用户提供出色的源调试体验
• 生成文档 - 从 markdown 文件、fsx 文件以及库中的 XML 文档注释 生成文档。
• 通过 持续部署 使用 GitHub Actions
  • [发布到 NuGet] - 将 NuGet 打包推送到 NuGet
    • 从 CHANGELOG.md 生成 包版本
    • 从 CHANGELOG.md 添加 包发行说明 元数据
  • [发布文档] - 将文档发布到 GitHub Pages

针对 应用程序

• 通过 Argu 进行基本参数解析示例
• 为 net6.0 编译应用程序 - 目标框架
  • 为了为 net6.0 编译
    • 需安装 .NET 6.0
• 为 win-x64、osx-x64 和 linux-x64 编译 - 运行时标识符。通过 dotnet-packaging 打包应用程序
  • 将 win-x64 应用程序打包到 .zip 文件中。
  • 将 osx-x64 应用程序打包到 .tar.gz 文件中。
  • 将 linux-x64 应用程序打包到 .tar.gz 文件中。

快速入门

从 NuGet 安装 dotnet 模板

dotnet new install "MiniScaffold::*"

然后选择

• 我想构建一个库

dotnet new mini-scaffold -n MyCoolNewLib --githubUsername MyGithubUsername

• 我想构建一个应用程序

dotnet new mini-scaffold -n MyCoolNewApp --githubUsername MyGithubUsername -ou console

脚手架默认使用 main 分支进行发布。如果您要从不同的分支发布，可以使用 --releaseBranch <branch name> 参数使用您的发布分支而不是默认分支。

构建

GitHub Actions

NuGet

稳定版本	预发布版本

选项

githubUserName

用于在 NuGet 包中自动配置作者信息，并配置 repo 位置的推送 URL。

outputType

默认为库

设置为 Console 或库项目时，将设置与其类型相关的支持基础设施。

已知问题

权限被拒绝

-bash: ./build.sh: Permission denied

这是因为 dotnet 模板丢失了文件的权限。( https://github.com/TheAngryByrd/MiniScaffold/pull/37 ) 添加了一个后置钩子来解决此问题，但这仅适用于 dotnet sdك 2.x 用户。dotnet sdك 1.x 需要运行 chmod +x ./build.sh

Appveyor 徽章没有正确生成

Appveyor根据项目名称生成URL的约定有一些细微差别。有关详细信息，请参阅此问题。

使用此模板的示例项目

• Chessie.Hopac
• Marten.FSharp
• FSharp.Control.WebSockets
• FSharp.Control.Redis.Streams
• FsLibLog
• Giraffe.HotReload
• EFCore.FSharp

此项目使用以下项目

• 深受Project Scaffold启发
• Paket
• FAKE
• Expecto
• Buildstats.info
• Source Link
• AltCover
• ReportGenerator
• Fantomas
• Argu
• dotnet-packaging
• FSharp.Formatting