semantic-release-yarn

# semantic-release-yarn [![npm](https://img.shields.io/npm/v/semantic-release-yarn)](https://www.npmjs.com/package/semantic-release-yarn) **A [semantic-release](https://semantic-release.gitbook.io/semantic-release/) plugin to publish [npm](https://www.npmjs.com) packages with [Yarn](https://yarnpkg.com). Comes with built-in support for monorepos.** ```diff { "branches": ["main"], "plugins": [ "@semantic-release/commit-analyzer", "@semantic-release/release-notes-generator", - "@semantic-release/npm", + "semantic-release-yarn", "@semantic-release/github", "@semantic-release/git" ] } ``` ## Table of contents   - [Install](#install) - [Usage](#usage) - [NPM registry authentication](#npm-registry-authentication) - [Monorepo support](#monorepo-support) - [Configuration](#configuration) - [Environment variables](#environment-variables) - [`.yarnrc.yml` file](#yarnrcyml-file) - [`package.json` file](#packagejson-file) - [Plugin options](#plugin-options) - [Examples](#examples) - [Only create package tarball](#only-create-package-tarball) - [Plugin steps](#plugin-steps) - [Development](#development) - [Roadmap](#roadmap) - [Credits](#credits)  ## Install ```bash yarn add --dev semantic-release-yarn ``` > **Note**: this plugin only works with **Yarn 2** and higher. ## Usage Use this plugin instead of the default [@semantic-release/npm](https://github.com/semantic-release/npm). The plugin must be added in the [**semantic-release** configuration](https://semantic-release.gitbook.io/semantic-release/usage/configuration), for example: ```json { "plugins": [ "@semantic-release/commit-analyzer", "@semantic-release/release-notes-generator", "semantic-release-yarn", "@semantic-release/github", "@semantic-release/git" ] } ``` ## NPM registry authentication Providing a NPM access token in your configuration is **required** and can be set either via [environment variables](#environment-variables) or the [`.yarnrc.yml`](#yarnrcyml-file) file. Make sure your access token has write access to the package you want to publish: - **When using a [classic/legacy token](https://docs.npmjs.com/creating-and-viewing-access-tokens#creating-legacy-tokens-on-the-website)**, it must be either: - A "**Publish**" token if you're not using 2FA or if 2FA is disabled for write operations (The "Require two-factor authentication for write actions" is unchecked in your 2FA settings) - An "**Automation**" token if 2FA is enabled for write operations (The "Require two-factor authentication for write actions" is checked in your 2FA settings) - **When using a [granular access token](https://docs.npmjs.com/creating-and-viewing-access-tokens#creating-granular-access-tokens-on-the-website)** make sure it has "**Read and write**" permissions on the package you want to publish. > **Note**: only the > [`npmAuthToken`](https://yarnpkg.com/configuration/yarnrc/#npmAuthToken) is > supported. The legacy > [`npmAuthIdent`](https://yarnpkg.com/configuration/yarnrc/#npmAuthIdent) > (`username:password`) authentication is strongly discouraged and not supported > by this plugin. ## Monorepo support Currently, simple monorepo versioning and publishing is supported. All workspaces versions will be aligned (a.k.a. fixed/locked mode) and when a new release is due, all workspaces will be published to the NPM registry. Monorepos are detected by the presence of a [`workspaces`](https://yarnpkg.com/configuration/manifest#workspaces) option in the root `package.json` file, for example: ```json { "workspaces": ["packages/*"] } ``` You can set the `mainWorkspace` [plugin option](#plugin-options) to use in notifications of new releases (e.g. in issue and pull request comments made by the [@semantic-release/github](https://github.com/semantic-release/github) plugin. See [our roadmap](#roadmap) for further implementation status. ## Configuration ### Environment variables | Variable | Description | | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `YARN_NPM_AUTH_TOKEN` | [NPM access token](https://docs.npmjs.com/creating-and-viewing-access-tokens). Translates to the [npmAuthToken](https://yarnpkg.com/configuration/yarnrc#npmAuthToken) `.yarnrc.yml` option. | | `YARN_NPM_PUBLISH_REGISTRY` | NPM registry to use. Translates to the [npmPublishRegistry](https://yarnpkg.com/configuration/yarnrc#npmPublishRegistry) `.yarnrc.yml` option. | Most other Yarn options could be specified as environment variables as well. Just prefix the names and write them in snake case. Refer to the [Yarnrc files](https://yarnpkg.com/configuration/yarnrc) documentation to see all options. > **Note**: the configuration set by environment variables will take precedence > over configuration set in the `.yarnrc.yml` file. ### `.yarnrc.yml` file Options can also be set in a `.yarnrc.yml` file. See [Yarnrc files](https://yarnpkg.com/configuration/yarnrc) for the complete list of option. ### `package.json` file The [`registry`](https://yarnpkg.com/configuration/manifest#publishConfig.registry) can be configured in the `package.json` and will take precedence over the configuration in environment variables and the `.yarnrc.yml` file: ```json { "publishConfig": { "registry": "https://registry.npmjs.org/" } } ``` > **Note**: the `@semantic-release/npm` plugin supports setting the > `publishConfig.tag` option. However, Yarn 2 > [doesn't seem to](https://github.com/yarnpkg/berry/issues?q=publishConfig+tag) > > [support this](https://yarnpkg.com/configuration/manifest#publishConfig). ### Plugin options These options can be added to the [**semantic-release** configuration](https://semantic-release.gitbook.io/semantic-release/usage/configuration), for example: ```json { "plugins": [ "@semantic-release/commit-analyzer", "@semantic-release/release-notes-generator", [ "semantic-release-yarn", { "npmPublish": false } ], "@semantic-release/github" ] } ``` | Options | Description | Default | | --------------- | ---------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `npmPublish` | Whether to publish the NPM package to the registry. If `false` the `package.json` version will still be updated. | `false` if the `package.json` [private](https://docs.npmjs.com/files/package.json#private) property is `true` and no monorepo is detected, `true` otherwise. | | `pkgRoot` | Directory path to publish. | `.` | | `tarballDir` | Directory path in which to write the package tarball. If `false` the tarball is not kept on the file system. | | | `mainWorkspace` | Name of monorepo workspace to be used in release info | | > **Note**: the `pkgRoot` directory must contain a `package.json`. The version > will be updated only in the `package.json` within the `pkgRoot` directory. ## Examples ### Only create package tarball The `npmPublish` and `tarballDir` option can be used to skip the publishing to the NPM registry and instead release the package tarball with another plugin. For example with the [@semantic-release/github](https://github.com/semantic-release/github) plugin: ```json { "plugins": [ "@semantic-release/commit-analyzer", "@semantic-release/release-notes-generator", [ "semantic-release-yarn", { "npmPublish": false, "tarballDir": "dist" } ], [ "@semantic-release/github", { "assets": "dist/*.tgz" } ] ] } ``` ## Plugin steps | Step | Description | | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `verifyConditions` | Verify Yarn 2 or higher is installed, verify the presence of a NPM auth token (either in an environment variable or an `.yarnrc.yml` file) and verify the authentication method is valid. | | `prepare` | Update the `package.json` version and [create](https://yarnpkg.com/cli/pack) the package tarball. | | `addChannel` | [Add a tag](https://yarnpkg.com/cli/npm/tag/add) for the release. | | `publish` | [Publish](https://yarnpkg.com/cli/npm/publish) to the npm registry. | ## Development After cloning this repository, optionally install [husky](https://typicode.github.io/husky/) so you never commit incorrectly formatted code: ```bash yarn husky install ``` ### Roadmap - [ ] Monorepo support - [x] Support for fixed versions - [x] Support for private/non-private root package - [x] Support for channels - [ ] Support for release information for each workspace - [ ] Support for independant versions (probably impossible without custom analyze-commits plugin) - [x] Get rid of CJS build once [upstream PR 2607](https://github.com/semantic-release/semantic-release/pull/2607) lands - [ ] Since we're using the latest AggregateError package, `semantic-release` is not picking up our error stack and we get a generic error message instead of a well formatted one. Hope this can be fixed once [upstream PR #2631](https://github.com/semantic-release/semantic-release/pull/2631) lands ## Credits ©️ Copyright 2022 Joram van den Boezem ♻️ Licensed under the MIT license ⚡ Powered by Node.js and TypeScript (and a lot of [amazing open source packages](./yarn.lock)) 🚀 This plugin is forked from the core [@semantic-release/npm](https://github.com/semantic-release/npm) plugin.