git-changelog-command-line - npm Package Compare versions

Comparing version 1.102.0 to 1.103.2

package.json

 {
-    "version": "1.102.0",
+    "version": "1.103.2",
     "name": "git-changelog-command-line",
@@ -4,0 +4,0 @@ "homepage": "https://github.com/tomasbjerre/git-changelog-command-line",

README.md

@@ -5,7 +5,13 @@ # Git Changelog Command Line
 [![NPM](https://img.shields.io/npm/v/git-changelog-command-line.svg?style=flat-square)](https://www.npmjs.com/package/git-changelog-command-line)
+[![NPM Downloads](https://img.shields.io/npm/dm/git-changelog-command-line.svg?style=flat)](https://www.npmjs.com/package/git-changelog-command-line)
+[![Docker Pulls](https://badgen.net/docker/pulls/tomasbjerre/git-changelog-command-line?icon=docker&label=pulls)](https://hub.docker.com/r/tomasbjerre/git-changelog-command-line/)
 
 This is a command line tool for generating a changelog, or releasenotes, from a GIT repository. It uses the [Git Changelog Lib](https://github.com/tomasbjerre/git-changelog-lib).
 
-This is a Java application (runnable `jar`) packaged into an `NPM` package for convenience. The runnable `jar` can be found in [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Ca%3A%22git-changelog-command-line%22) and used like `java -jar git-changelog-command-line-*.jar ....`. The `npm` package can be found in [NPM](https://www.npmjs.com/package/git-changelog-command-line).
+This is a Java application (runnable `jar`) packaged into an `NPM` package for convenience.
 
+- The runnable `jar` can be found in [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Ca%3A%22git-changelog-command-line%22) and used like `java -jar git-changelog-command-line-*.jar ....`.
+- The `npm` package can be found in [NPM](https://www.npmjs.com/package/git-changelog-command-line).
+- The `Docker` image can be found in [Dockerhub](https://hub.docker.com/r/tomasbjerre/git-changelog-command-line) and used like `docker run --mount src="$(pwd)",target=/usr/src/git-changelog-command-line,type=bind tomasbjerre/git-changelog-command-line:X --stdout`.
+
 ## Example - Simple
@@ -125,3 +131,3 @@
 {{#ifReleaseTag .}}
-## [{{name}}](https://gitlab.com/html-validate/html-validate/compare/{{name}}) ({{tagDate .}})
+## [{{name}}](https://github.com/tomasbjerre/someproject/compare/{{name}}) ({{tagDate .}})
 
@@ -133,3 +139,3 @@ {{#ifContainsType commits type='feat'}}
       {{#ifCommitType . type='feat'}}
- - {{#eachCommitScope .}} **{{.}}** {{/eachCommitScope}} {{{commitDescription .}}} ([{{hash}}](https://gitlab.com/html-validate/html-validate/commit/{{hashFull}}))
+ - {{#eachCommitScope .}} **{{.}}** {{/eachCommitScope}} {{{commitDescription .}}} ([{{hash}}](https://github.com/tomasbjerre/someproject/commit/{{hashFull}}))
       {{/ifCommitType}}
@@ -144,3 +150,3 @@ {{/commits}}
       {{#ifCommitType . type='fix'}}
- - {{#eachCommitScope .}} **{{.}}** {{/eachCommitScope}} {{{commitDescription .}}} ([{{hash}}](https://gitlab.com/html-validate/html-validate/commit/{{hashFull}}))
+ - {{#eachCommitScope .}} **{{.}}** {{/eachCommitScope}} {{{commitDescription .}}} ([{{hash}}](https://github.com/tomasbjerre/someproject/commit/{{hashFull}}))
       {{/ifCommitType}}
@@ -155,2 +161,32 @@ {{/commits}}
 
+Or you can prepend to the current changelog. You may get `$nextVersion` from `--print-next-version` and `$highestTag` from `--print-highest-version-tag`. Somehting like this:
+
+```shell
+npx git-changelog-command-line \
+ --from-ref $highestTag \
+ --to-ref HEAD \
+ --prepend-to-file CHANGELOG.md \
+ --template-content "
+## $nextVersion
+
+{{#ifContainsType commits type='feat'}}
+## Features
+  {{#commits}}
+    {{#ifCommitType . type='feat'}}
+  {{#eachCommitScope .}} **{{.}}** {{/eachCommitScope}} {{{commitDescription .}}} ([{{hash}}](https://github.com/tomasbjerre/someproject/commit/{{hashFull}}))
+    {{/ifCommitType}}
+  {{/commits}}
+{{/ifContainsType}}
+
+{{#ifContainsType commits type='fix'}}
+## Bug Fixes
+  {{#commits}}
+    {{#ifCommitType . type='fix'}}
+  {{#eachCommitScope .}} **{{.}}** {{/eachCommitScope}} {{{commitDescription .}}} ([{{hash}}](https://github.com/tomasbjerre/someproject/commit/{{hashFull}}))
+    {{/ifCommitType}}
+  {{/commits}}
+{{/ifContainsType}}
+"
+```
+
 ### Example NPM and `package.json`
@@ -309,2 +345,8 @@
                                                Default: null
+-jaf, --jira-additional-field <string>         Adds an additional field for Jira.
+                                               When configured, we will return
+                                               from Jira the result of this
+                                               field, if it exists. [Supports Multiple occurrences]
+                                               <string>: any string
+                                               Default: Empty list
 -jba, --jira-basic-auth <string>               Optional token to authenticate 
@@ -311,0 +353,0 @@ with Jira.

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

7560058

increased by0.07%

Number of lines in readme file

521

increased by8.77%

No dependency changes