公開と更新
これは Electron チュートリアルの 6 章 です。
学習目標
ここまでのチュートリアルで、ついにこちらが最後のステップです!ここではアプリを GitHub の Release に公開し、アプリのコードに自動更新を組み込みます。
update.electronjs.org の利用
Electron のメンテナにより、オープンソースアプリケーションの自動更新サービスが https://update.electronjs.org にて無償で提供されています。この必須要件は以下のとおりです。
- アプリが macOS または Windows で動作する
- アプリに GitHub の公開リポジトリがある
- Builds are published to GitHub releases
- ビルドが コード署名 されている (macOS のみ)
ここでは、既に全コードを GitHub の公開リポジトリにプッシュしているものとします。
If you're using an alternate repository host (e.g. GitLab or Bitbucket) or if you need to keep your code repository private, please refer to our step-by-step guide on hosting your own Electron update server.
GitHub Release を公開する
Electron Forge has Publisher plugins that can automate the distribution of your packaged application to various sources. このチュートリアルでは、GitHub Publisher を利用して、コードを GitHub の Release に公開します。
個人アクセストークンを作成する
Forge は GitHub 上のどのリポジトリにも権限無しには公開できません。 Forge が GitHub の Release にアクセスできるように、認可トークンを渡す必要があります。 The easiest way to do this is to create a new personal access token (PAT) with the public_repo scope, which gives write access to your public repositories. このトークンは必ず秘匿しておいてください。
GitHub Publisher のセットアップ
モジュールのインストール
Forge's GitHub Publisher is a plugin that needs to be installed in your project's devDependencies:
- npm
- Yarn
npm install --save-dev @electron-forge/publisher-github
yarn add --dev @electron-forge/publisher-github
Forge の公開システムの設定
インストールしたら、Forge の設定でセットアップする必要があります。 A full list of options is documented in the Forge's PublisherGitHubConfig API docs.
module.exports = {
publishers: [
{
name: '@electron-forge/publisher-github',
config: {
repository: {
owner: 'github-user-name',
name: 'github-repo-name'
},
prerelease: false,
draft: true
}
}
]
}
注意として、ここでは Release をドラフトとして作成するように Forge を設定しました。これにより、実際にエンドユーザに公開することなく、生成された成果物を含むリリースを確認できます。リリースノートを書き、頒布形式が動作することを再確認した後、手動で GitHub から Release を公開できます。
認証トークンの設定
Publisher に認証トークンを認識させる必要もあります。デフォルトでは、環境変数 GITHUB_TOKEN に格納されている値を使用します。
Running the release command
Add Forge's release command to your npm scripts.
//...
"scripts": {
"start": "electron-forge start",
"package": "electron-forge package",
"make": "electron-forge make",
"release": "electron-forge release"
},
//...
このコマンドは、設定したメーカーを実行し、出力された頒布形式を新しい GitHub の Release へ公開します。
- npm
- Yarn
npm run release
yarn release
デフォルトでは、ホスト OS とアーキテクチャに対応した頒布形式 1 つのみが公開されます。 Forge コマンドに --arch フラグを渡すことで、他アーキテクチャ用にも公開できます。
このリリース名は、プロジェクトの package.json ファイルの version フィールドに対応しています。
Optionally, you can also tag your releases in Git so that your release is associated with a labeled point in your code history. npm には便利な npm version コマンドがあり、バージョン更新やタグ付けができます。
おまけ: GitHub Actions で公開する
ローカルで公開することは苦痛です。特に、これではホストオペレーティングシステム用の頒布形式しか作成できません (つまり、macOS から Windows の .exe ファイルを公開できません)。
A solution for this would be to publish your app via automation workflows such as GitHub Actions, which can run tasks in the cloud on Ubuntu, macOS, and Windows. This is the exact approach taken by Electron Fiddle. 詳細については、Fiddle の ビルドとリリースのパイプライン と Forge の構成 をご参照ください。
アップデータコードの設置
GitHub の Release を使ったリリースシステムができたので、次は新しいリリースが出たときにアップデートをダウンロードするよう Electron アプリに指示します。 Electron apps do this via the autoUpdater module, which reads from an update server feed to check if a new version is available for download.
update.electronjs.org サービスは、アップデータ互換のフィードを提供します。例えば、Electron Fiddle v0.28.0 は https://update.electronjs.org/electron/fiddle/darwin/v0.28.0 のエンドポイントをチェックし、より新しい GitHub リリースが利用可能かどうか確認します。
GitHub にリリースが公開されると、update.electronjs.org サービスがあなたのアプリケーションのために動作します。あとは autoUpdater モジュールでフィードを設定するのみです。
To make this process easier, the Electron team maintains the update-electron-app module, which sets up the autoUpdater boilerplate for update.electronjs.org in one function call — no configuration required. このモジュールは、プロジェクトの package.json の "repository" フィールドと同じ update.electronjs.org のフィードを検索します。
まず、このモジュールを実行時の依存関係としてインストールします。
- npm
- Yarn
npm install update-electron-app
yarn add update-electron-app
次に、このモジュールをインポートしてメインプロセスですぐに呼び出します。
require('update-electron-app')()
これで全て完了です!パッケージされたアプリケーションは、新しい GitHub の Release が公開される毎に自身を更新します。
概要
このチュートリアルでは、Electron Forge の GitHub Publisher を設定し、アプリの頒布形式を GitHub の Release にアップロードする方法を説明しました。プラットフォーム間では常に頒布形式を生成することはできないため、そういったマシンを利用できない場合は、継続的インテグレーションのパイプラインでビルドと公開のフローを設定することを推奨します。
Electron アプリケーションは、autoUpdater モジュールにアップデートサーバーのフィードを指定することで、自己更新が可能です。 update.electronjs.org は、GitHub の Release で公開されているオープンソースアプリケーション向けに Electron が提供する無料のアップデートサーバーです。このサービスを利用するための Electron アプリの設定は、update-electron-app モジュールをインストールしインポートすることで簡単に行えます。
アプリケーションが update.electronjs.org の対象でない場合は、代わりに各自のアップデートサーバーを導入し、autoUpdater モジュールを自分で構成する必要があります。
ここまでで、Electron のチュートリアルは正式に終了しました。他のドキュメントも自由に探して、開発を楽しんでください!