Flutter发布工具插件publish_tools的使用

本包提供了一组通过Grinder任务来简化Dart和Flutter包发布的工具。以下是该包的一些特性：

目录

• 开始使用
  • 需求
  • pubspec.yaml配置
  • publish_tools.yaml配置
  • README.md/CHANGELOG.md模板
• Grinder任务
• 在下一个主要版本中

开始使用

需求

为了使用该包的GitHub发布功能，你的开发环境必须满足以下条件：

• git 必须在你的命令行路径中可用（如果你正在阅读此文档，那么这一步应该已经满足，如果没有，请参阅 - 安装Git）
• 你有一个GitHub账户，并且已经设置了一个个人访问令牌（参阅文档 - 创建一个个人访问令牌）
• 细粒度令牌需要以下权限：
  • 读写 - 管理 - 用于Homebrew tap仓库的创建
  • 读写 - 内容 - 用于更新仓库内容并创建tap的release
  • 只读 - 元数据 - 所有细粒度个人访问令牌的必需项

确保将你的publish_tools.yaml文件添加到.gitignore以防止将其发布到GitHub

pubspec.yaml配置

在你的pubspec.yaml文件中，添加以下内容到dev_dependencies部分：

dev_dependencies:
  ...
  grinder: ^0.9.5
  publish_tools: ^1.0.0+10

可选地，提供一个非默认路径的配置文件（记得添加到.gitignore）：

publish_tools: tool/config.yaml

publish_tools.yaml配置

创建一个名为tool的文件夹（如果你使用了grinder包，它应该已经存在）。在这个文件夹中创建你的publish_tools配置文件。

## 这是一个最小配置，一些字段将被赋予默认值

## 如果存在github键，它将覆盖默认值（从.git文件夹获取值）
# github:
#   repoUser: [你的GitHub用户名]
#   repoName: [默认为pubspec.yaml中的名称]

## 如果存在模板键，将覆盖默认值。下面与默认配置匹配。
# templates:
#   - name: README.md
#     type: overwrite
#   - name: CHANGELOG.md
#     type: prepend

commit: '示例提交消息'

创建以下代码：

import 'package:publish_tools/publish_tools.dart';

main(args) async {
  PublishTools.addAllTasks();

  grind(args);
}

[@DefaultTask](/user/DefaultTask)('如果未在命令行指定，则运行此任务')
[@Depends](/user/Depends)('pt-commit', 'pt-publish', 'pt-homebrew')
done() {
  log('主项目的提交完成');
  log('已发布到pub.dev/packages');
  log('brew tap的提交完成');
}

README.md/CHANGELOG.md模板

publish_tools可以帮助你保持README.md和CHANGELOG.md文件的最新状态。它使用mustache模板来动态重新生成你的README和CHANGELOG，当你运行相应的grinder任务时。

最简单的方法是复制现有的README.md和CHANGELOG.md文件到tool文件夹。现在你可以更新这些文件，以便在运行pt-markdown任务时动态替换这些字段。

例如，在上面的pubspec.yaml setup部分中，有关于如何更新你的pubspec.yaml以使用此工具的说明和示例。README中的publish_tools版本是动态设置的变量。以下是tool/README.md的mustache模板中的相应部分：

```yml
dev_dependencies:
  ...
  grinder: ^0.9.2
  publish_tools: ^{{ pubspec.version }}

`{{ pubspec.version }}`的值将由`pt-markdown`任务自动填充。

或者，对于`CHANGELOG.md`，可以使用以下模板：

```text
# Changelog

## {{ pubspec.version }}

{{ changes }}

默认情况下，每次运行pt-markdown任务时，README.md文件都会被覆盖。然而，默认情况下，CHANGELOG.md文件会被前置。这意味着提供的模板将被添加到现有CHANGELOG.md文件的开头。

其他可用于动态使用的值包括：

Grinder任务

以下是该包中可用的grinder任务列表：

在下一个主要版本中

• 支持Chocolatey
• 支持NPM

示例代码

以下是一个简单的示例代码，展示了如何使用publish_tools插件：

import 'package:publish_tools/publish_tools.dart';

// 此代码通常放置在[项目]/tool文件夹中
main(args) async {
  PublishTools.addAllTasks();

  grind(args);
}

[@DefaultTask](/user/DefaultTask)('如果未在命令行指定，则运行此任务')
[@Depends](/user/Depends)('pt-commit', 'pt-publish', 'pt-homebrew')
done() {
  log('主项目的提交完成');
  log('已发布到pub.dev/packages');
  log('brew tap的提交完成');
}