プロジェクトを公開する
プロジェクトを公開するには veryl publish コマンドを使います。公開とはバージョン番号とgitのリビジョンを紐づけることです。
$ veryl publish
[INFO ] Publishing release (0.2.1 @ 297bc6b24c5ceca9e648c3ea5e01011c67d7efe7)
[INFO ] Writing metadata ([path to project]/Veryl.pub)
veryl publish は以下のように公開されたバージョンの情報を含んだ Veryl.pub というファイルを生成します。
[[releases]]
version = "0.2.1"
revision = "297bc6b24c5ceca9e648c3ea5e01011c67d7efe7"
Veryl.pub と生成した後、gitのadd、commit、pushを行えば公開手続きは完了です。gitブランチはデフォルトブランチでなければなりません。これは Veryl が Veryl.pub をデフォルトブランチから探すためです。
$ git add Veryl.pub
$ git commit -m "Publish"
$ git push
Veryl.toml の [publish] セクションに publish_commit を設定して自動コミットを有効にすれば、gitのaddとcommitが自動で実行されます。
$ veryl publish
[INFO ] Publishing release (0.2.1 @ 297bc6b24c5ceca9e648c3ea5e01011c67d7efe7)
[INFO ] Writing metadata ([path to project]/Veryl.pub)
[INFO ] Committing metadata ([path to project]/Veryl.pub)
バージョンを上げる
--bump オプションを使うと公開と同時にバージョンを上げることもできます。公開と同様に、Veryl.toml の[publish] セクションに bump_commit を設定すれば自動でcommitされます。
$ veryl publish --bump patch
[INFO ] Bumping version (0.2.1 -> 0.2.2)
[INFO ] Updating version field ([path to project]/Veryl.toml)
[INFO ] Committing metadata ([path to project]/Veryl.toml)
[INFO ] Publishing release (0.2.2 @ 159dee3b3f93d3a999d8bac4c6d26d51476b178a)
[INFO ] Writing metadata ([path to project]/Veryl.pub)
[INFO ] Committing metadata ([path to project]/Veryl.pub)
レジストリへの登録
Veryl レジストリは公開されたプロジェクトの一覧を提供します。プロジェクトは veryl register で登録できます。
$ veryl register
レジストリはプロジェクトをリポジトリで識別するため、[project] セクションの repository フィールドが必要です。origin はチェックアウトによって変わるため、git の origin リモートではなく宣言された repository が使われます。
veryl register は登録前に確認を求めます。--yes オプションで確認を省略でき、コマンドを対話的に実行しない場合はこのオプションが必要です。
veryl publish でもプロジェクトを登録できます。その挙動は Veryl.toml の [publish] セクションの register で指定します。
true— publish 後に自動的に登録するfalse— 登録しない- 未設定 — 対話的に一度だけ問い合わせる
登録はコミットの push を行いません。公開されたバージョンは、そのリビジョンが push され、レジストリがリポジトリをクロールした後に見えるようになります。
レジストリが認識しないカテゴリが指定されている場合、警告として報告されます。
使用するレジストリは VERYL_REGISTRY_URL 環境変数で変更できます。
設定
全設定の説明はこちら。