はじめに
pub.devに公開したpackageのアップグレード方法について書かれた記事があまりないみたいなので、ざっくりまとめてみました。
僕がpub.devに公開した自作package「focused_area_ocr_flutter」の更新を生贄 事例にpackageの更新方法をご紹介します。
自作packageであるfocused_area_ocr_flutterの公開については、以前執筆したOCRのFlutterパッケージfocused_area_ocr_flutterを自作&公開してみたという記事にまとめてあります。
手順
1. packageに変更を加える
まず、packageのソースコード等に変更を加えます。
今回、僕はクラスやフィールドにドキュメントコメントを追加しました。
2. pubspec.yamlのversionを更新
次に、pubspec.yamlにあるversionを更新します。
僕は今回が初めての更新であり、更新前のversionが0.0.1だったため、0.0.2に変更しました。
3. CHANGELOG.mdの更新
CHANGELOG.mdに今回の更新に関する概要を記述します。
今回、僕は以下のようにCHANGELOG.mdを更新しました。
## 0.0.2
* Add documentation to classes and members.
## 0.0.1
* initial release.
4. dart pub publish --dry-runの実行
後はpackageの公開と同じ手順でpackageを更新することができます。
下記のコマンドを実行してpackage公開前の最終チェックを実施します。
このコマンドの実行により、公開するpackageのレイアウト規則に反していないか、余分なファイルが含まれていないかを確認することができます。
$ dart pub publish --dry-run
5. dart pub publishの実行
ここまでできたら、いよいよpackageの更新内容をpub.devにpublishします。
こちらもpackageの公開時と同様、以下のコマンドを実行します。
$ dart pub publish
コマンド実行後、Do you want to publish focused_area_ocr_flutter 0.0.2 to https://pub.dev (y/N)?と聞かれるので、yと回答します。
その後、以下のような表示があれば、packageの更新完了です！
Uploading... (2.8s)
Successfully uploaded https://pub.dev/packages/focused_area_ocr_flutter version 0.0.2, it may take up-to 10 minutes before the new version is available.
更新後のpub.dev
以下のように、version0.0.1→0.0.2の更新に成功しました。
※更新直後はPENDING状態になるため、packageのPUB POINTSがしばらくの間0表記になります。