ウィジェットセットを公開する

ウィジェットセットは、次のいずれかの方法で公開できます。

ウィジェットセットの新しいバージョンを公開しても、既存の使用箇所は更新されません。変更を表示するには、Workshop などの各ホストアプリケーションで、新しいバージョンを使用するように設定します。

プロジェクトをビルドする

通常、CI/CD パイプラインはビルド手順を自動化します。ローカルマシンから公開する場合は、手動で実行します。

ローカルでビルドする前に、ローカルマシンで開発するの手順に従って、FOUNDRY_TOKEN 環境変数を設定してください。次に、依存関係をインストールし、プロジェクトを Linter で解析して、本番用ビルドを作成します。

Copied!
1
2
3
npm install
npm run lint
npm run build

出力先の dist/ フォルダーにあるウィジェットセットの本番用ビルドの例は、次のとおりです。

Copied!
1
2
3
4
5
6
7
8
9
10
11
12
dist/
├── .palantir
│   └── widgets.config.json
├── assets
│   ├── allPaths-1o-wu5D1.js
│   ├── allPathsLoader-B5dDtRyf.js
│   ├── index-BKzgFDAn.js
│   ├── index-BvSuWPlB.js
│   ├── index-fzE76D9V.css
│   ├── index-JZHrjpfy.js
│   └── splitPathsBySizeLoader-BdSoFTZJ.js
└── index.html

特別なマニフェストファイル .palantir/widgets.config.json に、ビルドに含まれるウィジェットが記述されます。プロジェクトテンプレートから開始した場合、このファイルは通常、@osdk/widget.vite-plugin ↗ を使用してプロジェクトコードから自動的に生成されます。

公開するウィジェットセットのバージョンは、このマニフェストファイルに含まれています。@osdk/widget.vite-plugin を使用する場合、プロジェクト内の foundry.config.json ファイルの widgetSet.autoVersion フィールドに、バージョンの算出方法が記述されます。この値には、package.json から version フィールドを読み取る package-json、または git リポジトリのタグとコミットに基づいてバージョンを算出する git-describe を指定できます。

ユーザーインターフェースで .zip アーカイブファイルを手動でアップロードして公開する

ローカルマシンで、プロジェクトをビルドする手順に従います。ウィジェットセットの本番用ビルドを含む .zip アーカイブファイルを作成し、追加のフォルダー（出力先の dist/ フォルダーやそれに相当するフォルダーなど）が含まれていないことを確認してください。

次のコードスニペットは、bash ターミナルを使用して、dist/ フォルダー内の本番用ビルドを含む asset.zip アーカイブファイルをプロジェクトルートに作成します。お使いのオペレーティングシステムに適した任意の zip ツールを使用できます。

Copied!
1
2
cd dist/
zip -r ../asset.zip .

ウィジェットセットのページでリリースをアップロードを選択します。.zip アーカイブをダイアログにドラッグし、アップロードを選択します。

@osdk/cli の CLI コマンドで公開する

npm パッケージ @osdk/cli ↗ は、1つのコマンドで .zip アーカイブを作成し、公開します。このコマンドは外部の CI/CD パイプラインでも使用できます。

ローカルマシンのターミナルから公開するには、プロジェクトをビルドする手順に従います。

ターミナルから次の CLI コマンドを実行します。

Copied!
1
npx @osdk/cli@latest widgetset deploy

マニフェスト内のバージョンが 1.0.0 の本番用ビルドを公開した場合の出力例は、次のとおりです。

Copied!
1
2
3
4
5
6
7
ℹ Palantir OSDK CLI 0.26.3

ℹ Found version from manifest: 1.0.0
◐ Zipping widget set files
◐ Publishing widget set files
ℹ Zipped 1.04 MiB total over 11 files
✔ Publish complete

外部の CI/CD パイプラインから公開するには、プロバイダーのドキュメントに従って、プロジェクトをビルドし、@osdk/cli のデプロイコマンドを実行するワークフローの手順を設定します。

Foundry CI/CD を使用して公開する

Foundry Code Repositories を使用するウィジェットセットでは、タグビルド時にウィジェットセットをビルドして公開するように、Foundry CI/CD が自動的に設定されます。

ターミナルからタグを作成してプッシュするには、<x.y.z> をウィジェットセットのバージョンに置き換えて、次を実行します。

Copied!
1
2
git tag <x.y.z>
git push origin <x.y.z>

ビルドを監視するには、VS Code Workspaces または Code Repositories でタグを選択し、次に対象のタグを選択します。