ESLint Release Tool
This release tool has been extracted from the ESLint project so that it can be shared among projects. While it's intended for use in ESLint organization projects, it is shared freely so others might use it as well.
Please note that while this project is shared freely, it is not intended to be a general-purpose utility. The functionality is highly specific to how ESLint projects handle releases and the project will remain very focused on this use case.
Warning: There are minimal tests for this project and the API is rapidly changing. Use at your own risk.
You can install the ESLint release tool using npm:
$ npm install eslint-release --save-dev
To start, you'll need to define two environment variables:
NPM_TOKEN- a token to use for
npm publish. The token must be from a user that has permission to publish the package.
ESLINT_GITHUB_TOKEN- a token for a GitHub user that has
repopermission (used for posting release notes).
The ESLint release tool is designed to be used on the command line and is divided into two phases: package generation and package publishing.
To generate a regular release:
To generate a prerelease, you need to include the prerelease identifier:
$ eslint-generate-prerelease alpha
eslint-generate-prerelease generate a new version and update the changelog but will not push back to GitHub or publish to npm. It will generate an npm package and a
For both releases and prereleases, you can then publish the release:
This command publishes the generate npm package and pushes the changes to GitHub. The
.eslint-release-info.json file is required for this step to work correctly.
You can optionally include the release tool in another Node.js script:
var ReleaseOps = require("eslint-release");
What It Does
When you run the release tool for a regular release, the following steps take place:
- Updates your npm packages to ensure you're running everything with the version that would be installed with a fresh install (only outside of CI release)
npm testto validate the release
- Gathers the commit message for each commit since the last release
- Calculates the next release version based on the commit message format of the changes since the last release
CHANGELOG.mdand commits the changes
npm versionto update the version
- Pushes the repository to origin/master with tags (only outside of CI release)
- Converts all line endings to Unix style
- Publishes the package to npm
- Reverts any file changes
When you do a prerelease, the same steps are taken except that package is published to npm under the
next tag instead of
Issues and pull requests will be triaged and responded to as quickly as possible. We operate under the ESLint Contributor Guidelines, so please be sure to read them before contributing. If you're not sure where to dig in, check out the issues.
Where to ask for help?
Join our Chatroom