Liferay-js-publish NPM

liferay-js-publish

A script for publishing an NPM package via yarn version.

Simplifying assumptions:

You are working in a repository that uses Yarn
You develop on the "master" branch and update "stable" whenever you do a release
You publish using yarn version
You are millennial (or pretend to be) and expect your tools to use emoji 😎

Set-up

1. Preliminaries

You can skip installing liferay-js-publish and just use the latest version (ie. via npx liferay-js-publish).

It is safe to use liferay-js-publish as an implicit dependency because we control the package, we maintain all the projects that use the package, and we won't make any breaking changes (or at least, we won't make any undetected breaking changes).

If you really want to install it, either:

Install globally: yarn global add liferay-js-publish; or:
Add to a project: yarn add --dev liferay-js-publish; or:

But note that this brings the cost of noise in the package.json and yarn.lock, and the need to update multiple projects every time we update liferay-js-publish.

2. Create a ".yarnrc" file

Ensure you have a ".yarnrc" file in your package root declaring the desired commit message and tag format. For example, in a monorepo, you probably want to include the package name:

version-tag-prefix "liferay-fancy-package/v"
version-git-message "chore: prepare liferay-fancy-package/v%s"

In a single-package repo, something like this might be more appropriate:

version-tag-prefix "v"
version-git-message "chore: prepare v%s release"

If you don't have a ".yarnrc" file, liferay-js-publish will warn you during publishing and require you to type "y" in order to continue.

3. Add liferay-js-publish from a "postversion" script in your "package.json".

Assuming you have a "ci" script that runs tests, you should call that in your "preversion" script as well:

{
    "scripts": {
      "ci": "yarn lint && yarn format:check && yarn test",
      "preversion": "yarn ci"
      "postversion": "npx liferay-js-publish"
    }
}

If you don't have "preversion" and "postversion" scripts, liferay-js-publish will warn you during publishing and require you to type "y" in order to continue.

Usage

Prepare and release a new version with yarn version

# Either:
yarn version --patch # or --minor, or --major

# Or:
yarn version --new-version x.y.z

Origins

This was originally just a publish.js script in the root of the liferay-npm-tools repository.

Similar to what we did with liferay-changelog-generator, we extracted it into an NPM package so that it could be used from other projects, such as eslint-config-liferay. The intention for it is to be a very small script with (almost) no dependencies.

Example projects using liferay-js-publish

cross-spawn

@everything-registry/sub-chunk-2069

4 years ago

4 years ago

5 years ago

5 years ago