eslint-release
Advanced tools
Comparing version 0.9.1 to 0.9.2
@@ -0,1 +1,5 @@ | ||
v0.9.2 - August 2, 2016 | ||
* 1dd0a5f Docs: Update README with CI info (Nicholas C. Zakas) | ||
v0.9.1 - July 30, 2016 | ||
@@ -2,0 +6,0 @@ |
{ | ||
"name": "eslint-release", | ||
"version": "0.9.1", | ||
"version": "0.9.2", | ||
"description": "ESLint Release Tools", | ||
@@ -5,0 +5,0 @@ "main": "./lib/release-ops", |
@@ -21,3 +21,3 @@ [![NPM version][npm-image]][npm-url] | ||
## Usage | ||
## Local Usage | ||
@@ -38,14 +38,33 @@ The ESLint release tool is designed to be used on the command line and has two modes: regular release and prerelease. | ||
To run a release in a CI environment, be sure to set `NPM_TOKEN` environment variable and then run: | ||
You can optionally include the release tool in another Node.js script: | ||
```js | ||
var ReleaseOps = require("eslint-release"); | ||
``` | ||
## CI Usage | ||
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 `repo` permission (used for posting release notes). | ||
To run a release in a CI environment: | ||
``` | ||
$ eslint-ci-release | ||
``` | ||
You can optionally include the release tool in another Node.js script: | ||
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 `.releaseInfo.json` file. | ||
```js | ||
var ReleaseOps = require("eslint-release"); | ||
Your CI system must manually push the repository changes to GitHub (including the version tag). After that, you can publish release notes by running: | ||
``` | ||
$ eslint-gh-release | ||
``` | ||
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 | ||
@@ -52,0 +71,0 @@ |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
33699
107