github-release-from-changelog - npm Package Compare versions

Comparing version 1.3.0 to 1.3.1

CHANGELOG.md

@@ -0,1 +1,6 @@
+# 1.3.1 - 2018-01-22
+
+* [Fix "Keep A Changelog" version detection](https://github.com/MoOx/github-release-from-changelog/commit/b96ea68110ee580abd31fbcc028c92091c03682d)
+  by @igetgames
+
 # 1.3.0 - 2017-12-06
@@ -2,0 +7,0 @@

github-release-from-changelog.js

@@ -129,3 +129,3 @@ #!/usr/bin/env node
     (line.indexOf("# " + version) === 0 ||
-      (isKeepAChangelogFormat && line.indexOf("## [") === 0))
+      (isKeepAChangelogFormat && line.indexOf("## [" + version) === 0))
   ) {
@@ -136,5 +136,6 @@ start = true;
     (line.indexOf("# ") === 0 ||
-      (isKeepAChangelogFormat && line.indexOf("## [") === 0))
+      (isKeepAChangelogFormat && line.indexOf("## [") === 0) ||
+      (line.indexOf("[") === 0))
   ) {
-    // end with another # version
+    // end with another # version or a footer link
     return true;
@@ -141,0 +142,0 @@ } else if (start) {

package.json

 {
   "name": "github-release-from-changelog",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "Create GitHub releases from CHANGELOG.md",
@@ -5,0 +5,0 @@ "keywords": [

README.md

 # github-release-from-changelog [![NPM version](https://img.shields.io/npm/v/github-release-from-changelog.svg?style=flat)](https://www.npmjs.com/package/github-release-from-changelog)
 
-> Create GitHub releases from CHANGELOG.md
+> Create GitHub releases from `CHANGELOG.md`
 
-**Included in [npmpub(lish)](https://github.com/MoOx/npmpub) !.**
+**Included in [npmpub(lish)] !.**
 
@@ -17,8 +17,7 @@ You need:
 
-* a `package.json` with a `version` field
-* a git tag with the corresponding version in either `X.Y.Z` or `vX.Y.Z` formats
-* a `GITHUB_TOKEN` as an env var
+* a `package.json` with a `version` field.
+* a git tag with the corresponding version in either `X.Y.Z` or `vX.Y.Z` formats.
+* a `GITHUB_TOKEN` as an env var. See <https://github.com/MoOx/npmpub#requirements> for instructions.
 
-This tool edit the git tag on GitHub and create a GitHub release with the
-correct CHANGELOG.md section.
+This tool edits the git tag on GitHub and create a GitHub release with the correct `CHANGELOG.md` section.
 
@@ -37,4 +36,11 @@ ## Install
 
----
+## Advanced Installation and Usage
 
+github-release-from-changelog is fully integrated in [npmpub(lish)].
+Please follow the instructions at <https://github.com/MoOx/npmpub#install> to install and use it.
+npmpub(lish) automatically calls github-release-from-changelog by default.
+
+github-release-from-changelog also plays well with other publishing tools such as [release-it](https://www.npmjs.com/package/release-it).
+One can create a release using release-it (which also updates `package.json`, but does not free you from maintaining `CHANGELOG.md` for yourself) and then use github-release-from-changelog to create the release on GitHub.
+
 ## CONTRIBUTING
@@ -45,4 +51,11 @@
 
-## [CHANGELOG](CHANGELOG.md)
+## CHANGELOG
 
-## [LICENSE](LICENSE)
+See [CHANGELOG.md](CHANGELOG.md)
+
+## LICENSE
+
+The license is MIT.
+See [LICENSE](LICENSE).
+
+[npmpub(lish)]: https://github.com/MoOx/npmpub

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

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

42264

increased by2.49%

Lines of code

147

increased by0.68%

Number of lines in readme file

59

increased by28.26%

No dependency changes