Flutter版本日志处理插件changelog_proccessor_poc的使用

Flutter版本日志处理插件changelog_proccessor_poc的使用

特性

  • 获取一个所有版本都为链接的修改后的日志文件
  • 从pub.dev/api获取版本以防止断链错误
  • 生成所有出现的超链接，而不仅仅是标题

使用

从URL生成修改后的变更日志

ChangelogProcessor cp = await ChangelogProcessor.fromChangeLogURL(
    "uuid", // 包名
    Uri.parse("https://raw.githubusercontent.com/Daegalus/dart-uuid/master/CHANGELOG.md")); // CHANGELOG.md 的 URL
String modifiedLogs = cp.getProccessedLog(); // 获取处理后的日志字符串

从MD源生成修改后的变更日志

String source = """
v1.0.0
.....
.....
"""; // 变更日志源文本

List<String> versions = [
  "1.0.0",
  "1.0.1",
  // 添加更多版本
];

String modifiedLogs = ChangelogProcessor.fromChangeLogSource("..name", versions, source).getProcessedLog(); // 获取处理后的日志字符串

更多关于Flutter版本日志处理插件changelog_proccessor_poc的使用的实战教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter版本日志处理插件changelog_proccessor_poc的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


changelog_proccessor_poc 是一个用于处理 Flutter 项目版本日志的插件。它可以帮助开发者自动生成、管理和发布项目的版本更新日志。以下是如何使用该插件的基本步骤：

1. 安装插件

首先，你需要在 pubspec.yaml 文件中添加 changelog_proccessor_poc 插件的依赖项。

dependencies:
  flutter:
    sdk: flutter
  changelog_proccessor_poc: ^1.0.0  # 请根据实际情况使用最新版本

然后运行 flutter pub get 来安装插件。

2. 创建 CHANGELOG.md 文件

在项目的根目录下创建一个 CHANGELOG.md 文件，用于记录项目的版本更新日志。文件内容可以按照以下格式编写：

Changelog

[1.0.0] - 2023-10-01

Added

  • 初始版本发布

### 3. 配置 `changelog_proccessor_poc`

在项目的根目录下创建一个 `changelog_config.yaml` 文件，用于配置插件的参数。以下是一个示例配置：

```yaml
# changelog_config.yaml

# 输入的 CHANGELOG.md 文件路径
input: CHANGELOG.md

# 输出的 CHANGELOG.md 文件路径
output: CHANGELOG.md

# 版本号前缀
version_prefix: "v"

# 是否在发布时自动增加版本号
auto_increment_version: true

# 是否在发布时自动生成 GitHub Release
generate_github_release: true

# GitHub 仓库信息
github:
  owner: your_github_username
  repo: your_repo_name
  token: your_github_token

4. 使用插件生成版本日志

你可以通过命令行工具来生成版本日志。以下是一些常用的命令：

生成新的版本日志

flutter pub run changelog_proccessor_poc:generate

该命令会根据 CHANGELOG.md 文件中的内容生成新的版本日志，并自动更新 CHANGELOG.md 文件。

发布新版本

flutter pub run changelog_proccessor_poc:release

该命令会根据 changelog_config.yaml 文件中的配置，自动增加版本号、更新 CHANGELOG.md 文件，并生成 GitHub Release。

5. 集成到 CI/CD 流程

你可以将 changelog_proccessor_poc 集成到你的 CI/CD 流程中，自动化版本发布和日志管理。例如，在 GitHub Actions 中添加以下步骤：

- name: Generate Changelog
  run: flutter pub run changelog_proccessor_poc:generate

- name: Release Version
  run: flutter pub run changelog_proccessor_poc:release
回到顶部