Juliaパッケージ管理メモ

Last modified: August 30, 2021

Juliaのパッケージ管理のメモです。

JuliaRegistratorはGitHub appsで、下記サイトからインストールする。パッケージの更新(新規作成またはバージョンアップ)を公式レジストリに知らせるツール。

プロジェクトページの.github/workflowsに作成する(作成される?) Personal access tokenを使ってGitHubにアクセスしている場合はScopeでWorkflowにチェックを入れておかないと、.github/workflowsにpushできない

TagBot: 新しいバージョンをRegistratorで登録すると、自動的にリリースタグを作成してくれる。Registrator経由で公式リポジトリに新しいパッケージが登録された際に、JuliaTagBotが当該パッケージのリポジトリにissueを書き込みTagBotをトリガーする。
Documenter: ドキュメントを自動生成する。通常masterへのコミットやバージョンアップでトリガーされるようになっている。
CompatHelper: 定期的に公式リポジトリを確認しに行って、当該パッケージに互換性の問題が生じていたら知らせてくれる。
CI: プルリクエストが作成された時に自動的にテストしてカバレッジなどを教えてくれる。

デプロイキーはDocumenterのものを使い回すと楽。DocumenterToolsがSSHキーを生成してくれる。

using DocumenterTools
DocumenterTools.genkeys(user="username", repo="NicePackage.jl")

最初に表示される公開鍵は、リポジトリ設定のDeploy Keyに登録する。次に表示される秘密鍵は、リポジトリ設定のSecretにDOCUMENTER_KEYという名前で登録する。TagBotも公式ドキュメントではDOCUMENTER_KEYを使って自動デプロイする設定になっている。

TagBotがエラーでタグを作成できなかった時、手動でワークフローをトリガーして修正できるのはデフォルトで3日間である。それ以上時間が経ってしまった時は、TagBot.ymlのonのところに以下のようにlookbackの記述を入れると、手動で実行する際にコミットを遡れる期間を指定できるようになる。

on:
  issue_comment:
    types:
      - created
  workflow_dispatch:
    inputs:
      lookback:

JuliaのCI周辺は動きが激しく(Travisが突然商用になったり)、デプロイ環境が安定しないので、時々有志の環境整備ツールが供給される。ありがたや。

新規パッケージを登録するプルリクエストは、一定期間は登録が保留され、レジストリ管理者らによるレビューが行われる。

問題がない、もしくは適切な修正を施してマージされるとパッケージが登録される。

新規パッケージと同様の流れだが、CIのテストを全てパスし、Package.tomlに記載されたパッケージとその依存モジュールのバージョンがセマンティックバージョニングに従っていれば自動的にマージされる。

バージョンをスキップしている(数値の増分が1でない)場合、自動マージされないので注意が必要。

依存モジュールのバージョン指定に上限が無い場合は自動マージされないので注意が必要。特にメジャーリリース番号が0の場合、マイナーリリース番号の上限を指定しないとだめなので注意(0は正式リリースではないのでマイナーリリース間に互換性が無いとみなされる)。