# [`@stephansama`](https://github.com/stephansama) / multipublish [![source code](https://img.shields.io/badge/Source-666666?style=flat&logo=github&label=Github&labelColor=211F1F)](https://github.com/stephansama/packages/tree/main/core/multipublish) [![documentation](https://img.shields.io/badge/Documentation-211F1F?style=flat&logo=Wikibooks&labelColor=211F1F)](https://packages.stephansama.info/api/@stephansama/multipublish) [![npm](https://img.shields.io/npm/v/%40stephansama%2Fmultipublish?logo=npm&logoColor=red&color=211F1F&labelColor=211F1F)](https://www.npmx.dev/package/@stephansama/multipublish) [![socket.dev](https://badge.socket.dev/npm/package/@stephansama/multipublish)](https://socket.dev/npm/package/@stephansama/multipublish/overview) [![jsr](https://jsr.io/badges/@stephansama/multipublish)](https://jsr.io/@stephansama/multipublish) [![npm downloads](https://img.shields.io/npm/dw/@stephansama/multipublish?labelColor=211F1F)](https://www.npmx.dev/package/@stephansama/multipublish) [![yaml](https://img.shields.io/badge/yaml-2.8.2-CB171E.svg?logo=yaml&logoColor=ffffff&labelColor=CB171E)](https://npmx.dev/package/yaml) [![zod](https://img.shields.io/badge/zod-4.2.1-408AFF.svg?logo=zod&logoColor=ffffff&labelColor=408AFF)](https://npmx.dev/package/zod) [![@tanstack/intent](https://img.shields.io/badge/@tanstack/intent-0.0.41-00a6f4.svg?logo=tanstack&logoColor=ffffff&labelColor=00a6f4)](https://npmx.dev/package/@tanstack/intent) [![jsr](https://img.shields.io/badge/jsr-0.13.5-F7DF1E.svg?logo=jsr&logoColor=ffffff&labelColor=F7DF1E)](https://npmx.dev/package/jsr) [![tsdown](https://img.shields.io/badge/tsdown-0.21.10-3178C6.svg?logo=rolldown&logoColor=ffffff&labelColor=3178C6)](https://npmx.dev/package/tsdown)
Publish packages to multiple providers easily ##### Table of contents
Open Table of contents - [Installation](#installation) - [CLI Options](#cli-options) - [Usage](#usage) - [Configuration](#configuration) - [GitHub NPM Registry](#github-npm-registry) - [JSR Configuration](#jsr-configuration) - [Changesets](#changesets) - [JSR](#jsr) - [Published packages](#published-packages)
## Installation ```sh pnpm install @stephansama/multipublish ``` ## CLI Options | Option | Alias | Description | Type | | :--------------------- | :---- | :---------------------------------------------------- | :-------- | | `--config` | `-c` | Path to config file | `string` | | `--dry` | `-d` | Perform a dry run | `boolean` | | `--released` | `-r` | Packages that have been updated and require a publish | `array` | | `--releasedFile` | `-f` | File denoting which packages have been updated | `string` | | `--useChangesetStatus` | `-s` | Path to changeset status file used to version release | `boolean` | | `--verbose` | `-v` | Enable verbose logging | `boolean` | | `--versionJsr` | `-j` | Update version JSR configuration files | `boolean` | ## Usage ### Configuration You can configure `multipublish` by creating a configuration file (or object) in the root of your project. The following file formats are supported: - `package.json` - `.multipublishrc.cjs` - `.multipublishrc.js` - `.multipublishrc.json` - `.multipublishrc.mjs` - `.multipublishrc.ts` - `.multipublishrc.yaml` - `.multipublishrc.yml` - `.multipublishrc` - `.config/.multipublishrc.json` - `.config/.multipublishrc.yaml` - `.config/.multipublishrc.yml` - `.config/.multipublishrc` - `.config/multipublishrc.cjs` - `.config/multipublishrc.js` - `.config/multipublishrc.json` - `.config/multipublishrc.mjs` - `.config/multipublishrc.ts` - `.config/multipublishrc.yaml` - `.config/multipublishrc.yml` - `.config/multipublishrc` - `multipublish.config.cjs` - `multipublish.config.js` - `multipublish.config.mjs` - `multipublish.config.ts` ```json { "$schema": "./node_modules/@stephansama/multipublish/config/schema.json", "platforms": [ ["jsr", { "experimentalGenerateJSR": true, "defaultExclude": ["!dist"] }], [ "npm", { "registry": "https://npm.pkg.github.com", "tokenEnvironmentKey": "GITHUB_TOKEN" } ] ] } ``` ### GitHub NPM Registry If publishing to the GitHub NPM registry, you must add `packages` to permissions when using a GitHub token. And allow `write` and `read` permissions for workflows (located in repo settings > actions > general). ```yaml permissions: packages: write ``` ### JSR Configuration When publishing to JSR, you must either have a valid `jsr.json` or `deno.json`, or allow `experimentalGenerateJSR` using the config option. ### Changesets If you are using jsr this with changesets, please update your version script with a preversion script that calls the `multipublish` CLI in order to update your existing jsr configurations. #### JSR ```json { "scripts": { "preversion": "multipublish --useChangesetStatus --versionJsr", "version": "changeset version" } } ``` #### Published packages you can run multipublish after a changeset publish like so ```yaml - if: github.ref_name == 'main' name: 🦋 Create Changeset Release uses: changesets/action@v1 id: changesets with: commit: "chore: Update version for release" title: "chore: Update version for release" publish: pnpm run publish createGithubReleases: true - name: publish to other registries if: steps.changesets.outputs.published == 'true' run: | echo "${{ steps.changesets.outputs.publishedPackages }}" | multipublish ``` # Zod Schema ## Config _Object containing the following properties:_ | Property | Type | Default | | :------------------- | :---------------------- | :----------- | | **`platforms`** (\*) | [Platforms](#platforms) | | | `tmpDirectory` | `string` | `'.release'` | | `useChangesets` | `boolean` | `true` | _(\*) Required._ ## JsrPlatformOptions _Object containing the following properties:_ | Property | Type | Default | | :--------------------------- | :-------------- | :----------------- | | `allowSlowTypes` | `boolean` | `true` | | `defaultExclude` | `Array` | | | `defaultInclude` | `Array` | | | `experimentalGenerateJSR` | `boolean` | `false` | | `experimentalUpdateCatalogs` | `boolean` | `false` | | `tokenEnvironmentKey` | `string` | `'JSR_AUTH_TOKEN'` | _All properties are optional._ ## NpmPlatformOptions _Object containing the following properties:_ | Property | Type | Default | | :-------------------- | :--------------------------- | :------------------------------ | | `registry` | `string` | `'https://registry.npmjs.org/'` | | `strategy` | `'.npmrc' \| 'package.json'` | `'.npmrc'` | | `tokenEnvironmentKey` | `string` | `'NODE_AUTH_TOKEN'` | _All properties are optional._ ## Platforms *Array of `'jsr' | 'npm'` *or\* _Tuple:_
  1. `'jsr'`
  2. [JsrPlatformOptions](#jsrplatformoptions)
_or_ _Tuple:_
  1. `'npm'`
  2. [NpmPlatformOptions](#npmplatformoptions)
items.\*