Flutter Package 发布:元数据、示例与版本记录

梳理 pubspec、README、CHANGELOG、LICENSE 和 example 的职责。

适用版本

原文发布于 2021 年;发布命令按 Dart 官方文档更新。

本文目录
  1. pubspec 说明包的身份
  2. README、CHANGELOG 和 LICENSE 各自负责什么
  3. 用 example 展示完整用法
  4. 发布内容与版本
  5. 参考

包发布前,需要让别人知道它解决什么问题、如何调用、适用哪些平台,以及版本变化会不会影响已有代码。原记录中的 pubspec、变更记录、许可证和示例目录仍是这项工作的基础。

pubspec 说明包的身份

yaml
name: sample_widget_tools
description: Small reusable widgets for a Flutter project.
version: 0.1.0
repository: https://github.com/your-account/sample_widget_tools
issue_tracker: https://github.com/your-account/sample_widget_tools/issues

environment:
  sdk: '>=3.0.0 <4.0.0'

dependencies:
  flutter:
    sdk: flutter

名称、地址和 SDK 范围必须替换为项目真实信息。最低 SDK 约束应与实际使用的语言特性相符,不能只为了扩大兼容范围填写较低版本。仅内部使用的包可以设置 publish_to: none 防止误发到公开仓库。

README、CHANGELOG 和 LICENSE 各自负责什么

README 放安装方式、最小使用例子、主要参数与平台限制。CHANGELOG 按版本记录变化,尤其是需要调用方修改代码的调整。

markdown
## 0.1.0

- 提供基础组件及使用示例。

这是一段格式示例,正式发布时应换成该版本真正完成的功能。LICENSE 写明确切授权条款;第三方代码与资源的授权一并处理。原文把 BSD 3-Clause 作为示例,不能据此认定所有项目都应使用同一种许可证。

用 example 展示完整用法

包的核心逻辑放在 lib 中,例子放在 example。Flutter 示例可以在包根目录创建:

sh
flutter create example

示例工程依赖当前包的本地路径:

yaml
dependencies:
  sample_widget_tools:
    path: ../

这样读者能看到初始化、页面布局、资源与清理过程,避免 README 只剩一段无法放入项目的调用片段。

发布内容与版本

Dart 当前发布入口是:

sh
dart pub publish --dry-run
dart pub publish

第一条用于查看将上传的文件和发布检查结果;第二条执行发布。执行前应确认不会把账户文件、私钥、调试日志和内部配置纳入包内容,必要时使用 .pubignore。

版本一经发布会成为他人的依赖。修正内容需要发布新版本,不能把已经发布的版本当作随意覆盖的文件。发现错误版本时,按照 pub.dev 的版本撤回与维护机制处理。

参考

作者:NeverOuO。原载 NeverOuO 个人小站,现收录于云屿来文章与教程。

返回全部文章

把好用的工具分享给朋友

分享

发送链接,让朋友直接打开这个页面。

访问统计

我们统计页面浏览、渠道来源、产品入口点击与分享次数,用于了解产品如何被发现。这项统计不使用用户标识、Cookie 或跨站追踪,也不读取上传文件或表单内容。