Publish a widget set

A widget set can be published through one of the following methods:

Publishing a new widget set version does not update existing usages. To display the changes, configure each host application, such as Workshop, to use the new version.

Build a project

CI/CD pipelines typically automate the build steps. Complete them manually when publishing from your local machine.

Before building locally, follow Develop on your local machine to configure the FOUNDRY_TOKEN environment variable. Then install dependencies, lint the project, and create a production build:

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

An example production build of a widget set in an output dist/ folder looks like the following:

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

A special .palantir/widgets.config.json manifest file describes the widgets contained in the build which is typically produced automatically from the project code using @osdk/widget.vite-plugin ↗ when starting from project templates.

The version of the widget set to publish is included in this manifest file. When using @osdk/widget.vite-plugin, a foundry.config.json file in the project describes how the version is calculated in the widgetSet.autoVersion field. This may be package-json which reads the version field from package.json, or git-describe which calculates the version based on a git repository's tags and commits.

Publish with a manual upload of a .zip archive file in the user interface

On your local machine, follow the instructions for building a project. Create a .zip archive file containing the production build of your widget set, ensuring that there are no additional folders (such as the output dist/ or equivalent folder).

The following code snippet creates an asset.zip archive file in the project root with the production build in a dist/ folder using a bash terminal. Any suitable zip tool can be used for your operating system.

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

Select Upload release on the widget set page. Drag the .zip archive into the dialog, and then select Upload.

Publish with a CLI command from @osdk/cli

The npm package @osdk/cli ↗ creates the .zip archive and publishes it with a single command. You can also use the command in an external CI/CD pipeline.

To publish from a terminal on your local machine, follow the instructions for building a project.

Run the following CLI command from your terminal:

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

An example output for publishing a production build with the version 1.0.0 in the manifest will look like the following:

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

To publish from an external CI/CD pipeline, follow the provider's documentation to set up the workflow steps to build the project and run the @osdk/cli deploy command.

Use Foundry CI/CD to publish

For widget sets using Foundry Code Repositories, Foundry CI/CD is automatically set up to build and publish the widget set on tag builds.

To create and push a tag from a terminal, replace <x.y.z> with the widget set version and run:

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

To monitor the build, select Tags in VS Code Workspaces or Code Repositories, and then select the tag.