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
The ESLint release tool is designed to be used on the command line and has two modes: regular release and prerelease.
To run a regular release:
To run a prerelease, you need to include the prerelease identifier:
$ eslint-prerelease alpha
You can optionally include the release tool in another Node.js script:
var ReleaseOps = require("eslint-release");
When run in a CI environment like Jenkins, the ESLint release tool has different commands that allow for incorporation into more complex release scripts. 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).
To run a release in a CI environment:
This will generate a new version, update the changelog, and publish to npm but will not push back to GitHub. It will also generate a
Your CI system must manually push the repository changes to GitHub (including the version tag). After that, you can publish release notes by running:
This command looks for the
.releaseInfo.json file and uses that information to determine where to post release notes and what to post.
Note: In Jenkins,
eslint-gh-release must be run as the last step in the build (typically in a post-build script that occurs after the GitHub repository has been updated).
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
These folks keep the project moving and are resources for help:
- Nicholas C. Zakas (@nzakas) - project lead
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