fix: correctly obfuscate githubToken with verbose loglevel

refactor(nerf-dart): use module from npm
Merge pull request #58 from tlvince/get-last-release
2015-08-22 11:34:50 +02:00 · 2015-08-20 14:31:18 +02:00 · 2015-08-18 15:13:21 +02:00 · 2015-08-18 14:04:56 +01:00 · 2015-08-18 13:58:38 +01:00 · 2015-08-18 13:56:24 +02:00
9 changed files with 61 additions and 141 deletions
@@ -1,6 +1,15 @@
 # semantic-release
-| [![Build Status](https://travis-ci.org/semantic-release/semantic-release.svg?branch=next)](https://travis-ci.org/semantic-release/semantic-release) | [![Coverage Status](https://coveralls.io/repos/semantic-release/semantic-release/badge.svg?branch=next&service=github)](https://coveralls.io/github/semantic-release/semantic-release?branch=next) | [![Dependency Status](https://david-dm.org/semantic-release/semantic-release/next.svg)](https://david-dm.org/semantic-release/semantic-release/next) | [![devDependency Status](https://david-dm.org/semantic-release/semantic-release/next/dev-status.svg)](https://david-dm.org/semantic-release/semantic-release/next#info=devDependencies) | [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard) |
-| --- | --- | --- | --- | --- |
+
+
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard)
+[![Join the chat at https://gitter.im/semantic-release/semantic-release](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/semantic-release/semantic-release?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+[![Build Status](https://travis-ci.org/semantic-release/semantic-release.svg?branch=next)](https://travis-ci.org/semantic-release/semantic-release)
+[![Coverage Status](https://coveralls.io/repos/semantic-release/semantic-release/badge.svg?branch=next&service=github)](https://coveralls.io/github/semantic-release/semantic-release?branch=next)
+
+[![Dependency Status](https://david-dm.org/semantic-release/semantic-release/next.svg)](https://david-dm.org/semantic-release/semantic-release/next)
+[![devDependency Status](https://david-dm.org/semantic-release/semantic-release/next/dev-status.svg)](https://david-dm.org/semantic-release/semantic-release/next#info=devDependencies)

 `semantic-release` builds upon a set of conventions to give you **fully automated, semver-compliant package publishing**. It's mostly about _commit-messages_, but you can define more _heuristics_.

@@ -92,7 +101,7 @@ _A few notes on `npm` config_:

 ## Plugins

-There are four steps where you can customize the `semantic-release` behavior using plugins. A plugin is a regular [option](#options), but inside the `package.json` you can pass additional config.
+There are numerous steps where you can customize `semantic-release`'s behaviour using plugins. A plugin is a regular [option](#options), but passed inside the `release` block of `package.json`:

 ```json
 {
@@ -142,6 +151,10 @@ This plugins is responsible for verifying that a release should happen in the fi

 This plugin is responsible for verifying a release that was determined before and is about to be published. There is no default implementation. It additionally receives `nextRelease`, `lastRelease` and `commits` inside `config`. While `commits` is the same as with analyzeCommits, `nextRelease` contains a `type` (e.g. `'major'`) and the new version (e.g. `'1.0.0'`) and `lastRelease` contains the old `version`, the `gitHead` at the time of the release and the npm dist-`tag` (e.g. `'latest'`). Using this information you could [detect breaking changes](https://github.com/semantic-release/cracks) or hold back certain types of releases. Again: Be creative.

+### `getLastRelease`
+
+This plugin is responsible for determining a package's last release version. The [default implementation](https://github.com/semantic-release/last-release-npm) uses the last published version on a npm registry.
+
 ## ITYM*FAQ*LT
 > I think you might frequently ask questions like these

@@ -176,6 +189,28 @@ It is indeed a great idea because it _forces_ you to follow best practices. If y

 Note: Currently integration-tests don't run on Travis CI. If you know stuff about npm/Travis/Couch: Please help!

+## Badge
+
+Use this in one of your projects? Include one of these badges in your README.md to let people know that your package is published using `semantic-release`.
+
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+
+```md
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+```
+
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=plastic)](https://github.com/semantic-release/semantic-release)
+
+```md
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=plastic)](https://github.com/semantic-release/semantic-release)
+```
+
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release)
+
+```md
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release)
+```
+
 ## License

 MIT License
@@ -8,15 +8,9 @@
  "bugs": {
    "url": "https://github.com/semantic-release/semantic-release/issues"
  },
-  "bundleDependencies": [
-    "@semantic-release/commit-analyzer",
-    "@semantic-release/condition-travis",
-    "@semantic-release/error",
-    "@semantic-release/release-notes-generator"
-  ],
  "engines": {
-    "node": ">0.10",
-    "npm": ">2"
+    "node": ">=0.10",
+    "npm": ">=2"
  },
  "config": {
    "nyc": {
@@ -30,12 +24,13 @@
    "@semantic-release/commit-analyzer": "^2.0.0",
    "@semantic-release/condition-travis": "^4.0.0",
    "@semantic-release/error": "^1.0.0",
+    "@semantic-release/last-release-npm": "^1.1.1",
    "@semantic-release/release-notes-generator": "^2.0.0",
    "git-head": "^1.2.1",
    "github": "^0.2.4",
    "lodash": "^3.9.3",
+    "nerf-dart": "^1.0.0",
    "nopt": "^3.0.3",
-    "npm-registry-client": "^6.4.0",
    "npmconf": "^2.1.2",
    "npmlog": "^1.2.1",
    "parse-github-repo-url": "^1.0.0",
@@ -53,7 +48,7 @@
    "nyc": "^3.0.0",
    "proxyquire": "^1.5.0",
    "rimraf": "^2.4.0",
-    "standard": "^4.2.1",
+    "standard": "^5.0.2",
    "tap": "^1.3.1"
  },
  "homepage": "https://github.com/semantic-release/semantic-release/tree/next#readme",
@@ -52,9 +52,10 @@ npmconf.load({}, (err, conf) => {

  const config = {PREFIX, log, env, pkg, options, plugins, npm}

-  log.verbose(PREFIX, 'options:', _.assign({
-    githubToken: options.githubToken ? '***' : undefined
-  }), options)
+  let hide = {}
+  if (options.githubToken) hide.githubToken = '***'
+
+  log.verbose(PREFIX, 'options:', _.assign({}, options, hide))
  log.verbose(PREFIX, 'Verifying config.')

  const errors = require('./lib/verify')(config)
@@ -71,7 +72,7 @@ npmconf.load({}, (err, conf) => {
        if (!options.debug) process.exit(1)
      }

-      const nerfDart = require('./lib/nerf-dart')(npm.registry)
+      const nerfDart = require('nerf-dart')(npm.registry)
      let wroteNpmRc = false

      if (env.NPM_TOKEN) {
@@ -1,26 +0,0 @@
-const SemanticReleaseError = require('@semantic-release/error')
-
-const npmlog = require('npmlog')
-const RegClient = require('npm-registry-client')
-
-module.exports = function ({pkg, npm}, cb) {
-  npmlog.level = npm.loglevel || 'error'
-  const client = new RegClient({log: npmlog})
-
-  client.get(`${npm.registry}${pkg.name.replace('/', '%2F')}`, {
-    auth: npm.auth
-  }, (err, data) => {
-    if (err && err.statusCode === 404) return cb(null, {})
-    if (err) return cb(err)
-
-    const version = data['dist-tags'][npm.tag]
-
-    if (!version) return cb(new SemanticReleaseError(`There is no release with the dist-tag "${npm.tag}" yet. Tag a version first.`, 'ENODISTTAG'))
-
-    cb(null, {
-      version,
-      gitHead: data.versions[version].gitHead,
-      tag: npm.tag
-    })
-  })
-}
@@ -1,14 +0,0 @@
-// borrowed from https://github.com/npm/npm/blob/master/lib/config/nerf-dart.js
-const url = require('url')
-
-/* istanbul ignore next */
-module.exports = function toNerfDart (uri) {
-  let parsed = url.parse(uri)
-  delete parsed.protocol
-  delete parsed.auth
-  delete parsed.query
-  delete parsed.search
-  delete parsed.hash
-
-  return url.resolve(url.format(parsed), '.')
-}
@@ -5,7 +5,8 @@ let exports = module.exports = function (options) {
    analyzeCommits: exports.normalize(options.analyzeCommits, '@semantic-release/commit-analyzer'),
    generateNotes: exports.normalize(options.generateNotes, '@semantic-release/release-notes-generator'),
    verifyConditions: exports.normalize(options.verifyConditions, '@semantic-release/condition-travis'),
-    verifyRelease: exports.normalize(options.verifyRelease, './plugin-noop')
+    verifyRelease: exports.normalize(options.verifyRelease, './plugin-noop'),
+    getLastRelease: exports.normalize(options.getLastRelease, '@semantic-release/last-release-npm')
  }
 }

@@ -2,14 +2,14 @@ const _ = require('lodash')
 const auto = require('run-auto')
 const semver = require('semver')

-const getLastRelease = require('./lib/last-release')
 const getCommits = require('./lib/commits')
 const getType = require('./lib/type')

 module.exports = function (config, cb) {
-  const {plugins} = config
+  const { plugins } = config
+
  auto({
-    lastRelease: getLastRelease.bind(null, config),
+    lastRelease: plugins.getLastRelease.bind(null, config),
    commits: ['lastRelease', (cb, results) => {
      getCommits(_.assign({
        lastRelease: results.lastRelease
@@ -1,79 +0,0 @@
-const { defaults } = require('lodash')
-const test = require('tap').test
-
-require('../mocks/registry')
-const lastRelease = require('../../dist/lib/last-release')
-
-const npm = {
-  registry: 'http://registry.npmjs.org/',
-  tag: 'latest'
-}
-
-test('last release from registry', (t) => {
-  t.plan(5)
-
-  t.test('get release from package name', (tt) => {
-    lastRelease({
-      pkg: {name: 'available'},
-      npm
-    }, (err, release) => {
-      tt.error(err)
-      tt.is(release.version, '1.33.7', 'version')
-      tt.is(release.gitHead, 'HEAD', 'gitHead')
-      tt.is(release.tag, 'latest', 'dist-tag')
-
-      tt.end()
-    })
-  })
-
-  t.test('get release from a tagged package\'s name', (tt) => {
-    lastRelease({
-      pkg: {name: 'tagged'},
-      npm: defaults({tag: 'foo'}, npm)
-    }, (err, release) => {
-      tt.error(err)
-      tt.is(release.version, '0.8.15', 'version')
-      tt.is(release.gitHead, 'bar', 'gitHead')
-      tt.is(release.tag, 'foo', 'dist-tag')
-
-      tt.end()
-    })
-  })
-
-  t.test('get error from an untagged package\'s name', (tt) => {
-    lastRelease({
-      pkg: {name: 'untagged'},
-      npm: defaults({tag: 'bar'}, npm)
-    }, (err) => {
-      tt.is(err.code, 'ENODISTTAG', 'error')
-
-      tt.end()
-    })
-  })
-
-  t.test('get release from scoped package name', (tt) => {
-    lastRelease({
-      pkg: {name: '@scoped/available'},
-      npm
-    }, (err, release) => {
-      tt.error(err)
-      tt.is(release.version, '1.33.7', 'version')
-      tt.is(release.gitHead, 'HEAD', 'gitHead')
-      tt.is(release.tag, 'latest', 'dist-tag')
-
-      tt.end()
-    })
-  })
-
-  t.test('get nothing from not yet published package name', (tt) => {
-    lastRelease({
-      pkg: {name: 'unavailable'},
-      npm
-    }, (err, release) => {
-      tt.error(err)
-      tt.is(release.version, undefined, 'no version')
-
-      tt.end()
-    })
-  })
-})
@@ -6,9 +6,16 @@ const pre = proxyquire('../../dist/pre', {
  'child_process': require('../mocks/child-process')
 })

+const versions = {
+  available: '1.0.0'
+}
+
 const plugins = {
  verifyRelease: (release, cb) => cb(null, release),
-  analyzeCommits: (commits, cb) => cb(null, 'major')
+  analyzeCommits: (commits, cb) => cb(null, 'major'),
+  getLastRelease: ({ pkg }, cb) => {
+    cb(null, { version: versions[pkg.name] || null, gitHead: 'HEAD' })
+  }
 }

 const npm = {
Author	SHA1	Message	Date
Stephan Bönnemann	b47311d565	fix: correctly obfuscate githubToken with verbose loglevel	2015-08-22 11:34:50 +02:00
Stephan Bönnemann	810b3533dd	refactor(nerf-dart): use module from npm	2015-08-20 14:31:18 +02:00
Stephan Bönnemann	b397ffe91f	Merge pull request #58 from tlvince/get-last-release Document the getLastRelease plugin	2015-08-18 15:13:21 +02:00
Tom Vincent	471a67fc31	docs(readme): document the getLastRelease plugin	2015-08-18 14:04:56 +01:00
Tom Vincent	557c46b8dd	docs(readme): enhance plugin section grammar	2015-08-18 13:58:38 +01:00
Ari PoradandStephan Bönnemann	7ceac76689	feat(plugins): add getLastRelease hook The code to determine the last-release is now in its own repository: https://github.com/semantic-release/last-release-npm One can overwrite that behavior by defining a "getLastRelease" plugin. This way one can decouple semantic-release from npm, e.g. by implementing a git-tag based version. This is already worked on: https://github.com/semantic-release/last-release-git-tag Closes #56	2015-08-18 13:56:24 +02:00
Stephan Bönnemann	77349fcdf1	docs(readme): add badge section	2015-08-10 22:04:21 +02:00
Stephan Bönnemann	aae79cab72	docs(readme): remove table around badges	2015-08-10 21:58:45 +02:00
Stephan Bönnemann	55364ded40	fix(package): remove dependency bundling Removes dependency bundling, because it's broken for scoped modules with npm right now. Keeps npm from logging four ugly warnings upon install. Can be reverted once https://github.com/npm/npm/issues/9175 is closed.	2015-08-10 17:10:58 +02:00
Stephan Bönnemann	3a7be436e9	chore(package): update standard	2015-08-10 17:09:46 +02:00
The Gitter BadgerandStephan Bönnemann	2b284fcc90	docs(readme): added Gitter badge	2015-08-10 17:03:20 +02:00
Stephan Bönnemann	fb1aa80f26	fix(package): fix version ranges for engines to include specified versions	2015-08-04 14:15:52 +02:00