conventional-github-releaser - npm Package Compare versions

Comparing version 3.0.0 to 3.1.0

CHANGELOG.md

@@ -6,2 +6,13 @@ # Change Log
 
+<a name="3.1.0"></a>
+# [3.1.0](https://github.com/conventional-changelog/releaser-tools/compare/conventional-github-releaser@3.0.0...conventional-github-releaser@3.1.0) (2018-05-31)
+
+
+### Features
+
+* **github:** output debug info ([a1ab945](https://github.com/conventional-changelog/releaser-tools/commit/a1ab945)), closes [#67](https://github.com/conventional-changelog/releaser-tools/issues/67)
+
+
+
+
 <a name="3.0.0"></a>
@@ -8,0 +19,0 @@ # [3.0.0](https://github.com/conventional-changelog/releaser-tools/compare/conventional-github-releaser@2.0.2...conventional-github-releaser@3.0.0) (2018-05-29)

package.json

@@ -37,6 +37,7 @@ {
   },
-  "version": "3.0.0",
+  "version": "3.1.0",
   "dependencies": {
     "conventional-changelog": "^1.1.0",
     "dateformat": "^3.0.0",
+    "debug": "^3.1.0",
     "gh-got": "^7.0.0",
@@ -43,0 +44,0 @@ "git-semver-tags": "^1.0.0",

README.md

@@ -5,3 +5,3 @@ # conventional-github-releaser
 [![codecov.io](https://codecov.io/gh/conventional-changelog/releaser-tools/coverage.svg?branch=master)](https://codecov.io/gh/conventional-changelog/releaser-tools?branch=master)
-[![Join the chat at https://gitter.im/conventional-changelog/conventional-github-releaser](https://badges.gitter.im/conventional-changelog/conventional-github-releaser.svg)](https://gitter.im/conventional-changelog/conventional-github-releaser)
+[![Join the chat at https://gitter.im/conventional-changelog/releaser-tools](https://badges.gitter.im/conventional-changelog/releaser-tools.svg)](https://gitter.im/conventional-changelog/conventional-github-releaser)
 
@@ -196,6 +196,19 @@ > Make a new GitHub release from git metadata.
 
-## License
+## Debugging
 
-MIT © [Steve Mao](https://github.com/stevemao)
+To assist users of `conventional-github-releaser` with debugging the behavior of this module we use the [debug](https://www.npmjs.com/package/debug) utility package to print information about the release process to the console. To enable debug message printing, the environment variable `DEBUG`, which is the variable used by the `debug` package, must be set to a value configured by the package containing the debug messages to be printed.
 
+To print debug messages on a unix system set the environment variable `DEBUG` with the name of this package prior to executing `conventional-github-releaser`:
+
+```bash
+DEBUG=conventional-github-releaser conventional-github-releaser
+```
+
+On the Windows command line you may do:
+
+```bash
+set DEBUG=conventional-github-releaser
+conventional-github-releaser
+```
+
 ## Node Support Policy
@@ -218,1 +231,5 @@
 Please read our [contributing guide](https://github.com/conventional-changelog/releaser-tools/blob/master/CONTRIBUTING.md) to see how you may contribute to this project.
+
+## License
+
+MIT © [Steve Mao](https://github.com/stevemao)

src/index.js

@@ -5,2 +5,3 @@ 'use strict'
 const conventionalChangelog = require('conventional-changelog')
+const debug = require(`debug`)(`conventional-github-releaser`)
 const gitSemverTags = require('git-semver-tags')
@@ -80,2 +81,3 @@ const ghGot = require('gh-got')
 
+          const url = `repos/${context.owner}/${context.repository}/releases`
           const options = {
@@ -91,2 +93,3 @@ body: {
           }
+          debug(`posting %o to the following URL - ${url}`, options)
 
@@ -101,6 +104,4 @@ if (auth.token) {
 
-          const promise = ghGot('repos/' + context.owner + '/' + context.repository + '/releases', options)
+          promises.push(ghGot(url, options))
 
-          promises.push(promise)
-
           cb()
@@ -107,0 +108,0 @@ }, function () {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

24693

increased by5.67%

Lines of code

312

increased by0.65%

Number of lines in readme file

233

increased by7.87%

Worsened metrics

Dependency count

12

increased by9.09%

Number of low supply chain risk alerts

6

increased by20%

Dependency changes

• + Addeddebug@^3.1.0

• + Addeddebug@3.2.7(transitive)

• + Addedms@2.1.3(transitive)