Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

GitHub でパッケージを公開する

💡 お知らせ: このドキュメントはAIによって翻訳されています。表現に違和感がある場合は、原文(英語)を参照するか、翻訳にご協力ください。

Flix のパッケージは GitHub 上で公開されます。

パッケージを自動で公開する

以下の手順に従うことで、Flix は自動的にパッケージ化を行い、GitHub 上にアーティファクト(Artifact)を公開できます:

  1. マニフェスト(Manifest)である flix.toml があることを確認します(なければ init で作成します)。
  2. flix.toml の version フィールドが正しいことを確認します。
  3. flix.toml の repository フィールドが正しいことを確認します。(例:repository = "github:user/repo"
  4. 対象のリポジトリの Contents に対して読み取り・書き込みのアクセス権を持つ GitHub トークンを持っていることを確認します。
    • 持っていない場合は、GitHub の Settings > Developer settings > Personal access tokens に移動して、新しいトークンを作成します。
  5. checktest を実行して、すべてが問題ないことを確認します。
  6. release --github-token <TOKEN> を実行します。次のように表示されるはずです:
Found `flix.toml'. Checking dependencies...
Resolving Flix dependencies...
Downloading Flix dependencies...
Resolving Maven dependencies...
  Running Maven dependency resolver.
Downloading external jar dependencies...
Dependency resolution completed.
Release github:user/repo v1.2.3? [y/N]: y
Building project...
Publishing new release...

 Successfully released v1.2.3
 https://github.com/user/repo/releases/tag/v1.2.3

ヒント: GitHub 上で公開されているパッケージの例としては、Museum Project を参照してください。

ヒント: 環境変数 GITHUB_TOKEN が利用可能な場合、Flix はそこから GitHub トークンを読み取ります。

ヒント: ファイル .GITHUB_TOKEN が利用可能な場合、Flix はそこからも GitHub トークンを読み取ります。

注意: 空の GitHub リポジトリに対してアーティファクトを公開することはできません。

警告: トークンは必ず安全に保管してください!

パッケージを手動で公開する

以下の手順に従うことで、パッケージを手動で公開することもできます:

  1. マニフェストである flix.toml があることを確認します(なければ init で作成します)。
  2. flix.toml の version フィールドが正しいことを確認します。
  3. checktest を実行して、すべてが正しいことを確認します。
  4. build-pkg を実行します。artifact ディレクトリにファイルが生成されていることを確認します。
  5. GitHub 上のリポジトリに移動します:
    1. “Releases” をクリックします。
    2. “Draft new release” をクリックします。
    3. v1.2.3 の形式でタグを入力します(つまり SemVer を使用します)。
    4. artifact ディレクトリにある package.fpkgflix.toml をアップロードします。

警告: パッケージファイル(foo.fpkg)とマニフェストファイル(flix.toml)の両方をアップロードする必要があります。