github-release-notes - npm Package Compare versions

Comparing version 0.6.3 to 0.7.0

CHANGELOG.md

 # Changelog
 
+## 0.6.3 (13/03/2017)
+
+- [**bug**] Fix multiple repo information [#48](https://github.com/github-tools/github-release-notes/issues/48)
+
+
+ --- 
+
 ## 0.6.2 (13/03/2017)
@@ -4,0 +11,0 @@

package.json

 {
-    "name": "github-release-notes",
-    "version": "0.6.3",
-    "description": "Node module to publish release notes based on commits between the last two tags.",
-    "main": "./github-release-notes.js",
-    "scripts": {
-        "start": "node github-release-notes.js",
-        "test": "grunt test",
-        "docs": "node_modules/.bin/jsdoc -c .jsdoc.conf.json --verbose"
-    },
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/alexcanessa/github-release-notes.git"
-    },
-    "preferGlobal": "true",
-    "bin": {
-        "gren": "bin/gren.js"
-    },
-    "keywords": [
-        "Github",
-        "Release",
-        "notes",
-        "Tag",
-        "Changelog",
-        "Changelog Generator",
-        "Issues",
-        "Commits"
-    ],
-    "author": "alexcanessa",
-    "contributors": [
-        "Alex Canessa <[e-mail]>"
-    ],
-    "license": "ISC",
-    "bugs": {
-        "url": "https://github.com/alexcanessa/github-release-notes/issues"
-    },
-    "homepage": "https://github.com/alexcanessa/github-release-notes#readme",
-    "dependencies": {
-        "chalk": "^1.1.3",
-        "connectivity": "^1.0.0",
-        "deep-assign": "^2.0.0",
-        "es6-promise": "^3.2.1",
-        "github-api": "^3.0.0",
-        "require-yaml": "0.0.1"
-    },
-    "devDependencies": {
-        "eslint": "^3.6.0",
-        "eslint-config-standard": "^6.0.1",
-        "eslint-plugin-promise": "^3.5.0",
-        "eslint-plugin-standard": "^2.0.0",
-        "grunt": "^1.0.1",
-        "grunt-contrib-nodeunit": "^1.0.0",
-        "grunt-eslint": "^19.0.0",
-        "jsdoc": "^3.4.3",
-        "minami": "^1.1.1"
-    }
+  "name": "github-release-notes",
+  "version": "0.7.0",
+  "description": "Node module to publish release notes based on commits between the last two tags.",
+  "main": "./github-release-notes.js",
+  "scripts": {
+    "start": "node github-release-notes.js",
+    "test": "grunt test",
+    "docs": "node_modules/.bin/jsdoc -c .jsdoc.conf.json --verbose"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/alexcanessa/github-release-notes.git"
+  },
+  "preferGlobal": "true",
+  "bin": {
+    "gren": "bin/gren.js"
+  },
+  "keywords": [
+    "Github",
+    "Release",
+    "notes",
+    "Tag",
+    "Changelog",
+    "Changelog Generator",
+    "Issues",
+    "Commits"
+  ],
+  "author": "alexcanessa",
+  "contributors": [
+    "Alex Canessa <[e-mail]>"
+  ],
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/alexcanessa/github-release-notes/issues"
+  },
+  "homepage": "https://github.com/alexcanessa/github-release-notes#readme",
+  "dependencies": {
+    "chalk": "^1.1.3",
+    "connectivity": "^1.0.0",
+    "es6-promise": "^3.2.1",
+    "github-api": "^3.0.0",
+    "require-yaml": "0.0.1"
+  },
+  "devDependencies": {
+    "eslint": "^3.6.0",
+    "eslint-config-standard": "^6.0.1",
+    "eslint-plugin-promise": "^3.5.0",
+    "eslint-plugin-standard": "^2.0.0",
+    "grunt": "^1.0.1",
+    "grunt-contrib-nodeunit": "^1.0.0",
+    "grunt-eslint": "^19.0.0",
+    "jsdoc": "^3.4.3",
+    "minami": "^1.1.1",
+    "object-assign-deep": "0.0.4"
+  }
 }

README.md

@@ -20,205 +20,41 @@ # Github Release Notes
 
-## Usage
+## Setup
 
-**gren** can be ran through the terminal, but before you can use it, you need to set up a couple of things.
+First generate a `github token` at [this link](https://help.github.com/articles/creating-an-access-token-for-command-line-use/). _You only need "repo" scope._
+Then add this to  `~/.bash_profile` or `~/.zshrc`):
 
-### Github Informations
-
-**gren** by default looks for your local git configuration to get the repo informations. This means you can run the command directly from the git repo folder.
-
-Otherwise, you can run it from wherever and specify a different repo as target, with:
-
 ```shell
-gren --username=[username] --repo=[repo name]
-```
-
-#### Token
-
-To work, **gren** needs a `github token` (that can be easily generated following [this link](https://help.github.com/articles/creating-an-access-token-for-command-line-use/)). _You only need "repo" scope._
-
-Once generated, you can run the gren command with the token as variable:
-
-```shell
-gren --token=your_token_here
-```
-
-Or you can add it to your `~/.bash_profile` or `~/.zshrc`) as follows:
-
-```shell
 export GREN_GITHUB_TOKEN=your_token_here
 ```
 
-And you're ready to use it! Just run this command in your terminal:
+## Basic Usage
 
 ```shell
+# Navigate to your project directory
+cd ~/Path/to/repo
+# Run the task
 gren
 ```
 
-The module will look for the last tag, get all the issues closed in the time between that tag and the one before, and it will build release notes and draft the new release!
+Otherwise, you can run it anywhere passing the repo information:
 
-## Options
-
-Following the options for the module:
-
-### Global options
-
-| Command | Options | Description | Default |
-| ------- | ------- | ----------- | ------- |
-| `--username` | **Required** | The username of the repo _e.g. `github-tools`_ | `null` |
-| `--repo` | **Required** | The repository name _e.g. `github-release-notes`_ | `null` |
-| `--action`| `release` `changelog` | The **gren** action to run. _(see details below for changelog generator)_ | `release` |
-| `--ignore-labels` | `wont_fix` `wont_fix,duplicate` | Ignore issues that contains one of the specified labels. | `false` |
-| `--ignore-issues-with` | `wont_fix` `wont_fix,duplicate` | Ignore issues that contains one of the specified labels. | `false` |
-| `--data-source` | `issues` `commits` | The informations you want to use to build release notes. | `issues` |
-| `--prefix` | **String** `e.g. v1.0.1` | Add a prefix to the tag version. | `null` |
-| `--override` | **Flag** | Override the release notes if existing. | `false` |
-| `--include-messages` | `merge` `commits` `all` | Filter the messages added to the release notes. _Only used when `data-source` used is `commits` | `commits` |
-
-### Release options
-
-| Command | Options | Description | Default |
-| ------- | ------- | ----------- | ------- |
-| `--draft` | **Flag** | Set the release as a draft. | `false` |
-| `--prerelease` | **Flag** | To set the release as a prerelease. | `false` |
-| `--tags`    |   `0.1.0` `0.2.0,0.1.0` `all` |   A specific tag or the range of tags to build the release notes from. You can also specify `all` to write all releases. _(To override  existing releases use the --override flag)_ | `false` |
-
-### Changelog options
-
-| Command | Options | Description | Default |
-| ------- | ------- | ----------- | ------- |
-| `--time-wrap` | `latest` `history` | The release notes you want to include in the changelog. | `latest` |
-| `--changelog-filename` | **String**, like `changelog.md` | The name of the changelog file. | `CHANGELOG.md` |
-
-
-### Config file
-
-You can create a configuration file where the task will be ran, where to specify your options.
-The options in the file would be camelCase *e.g*:
-
-```json
-{
-    "action": "release",
-    "timeWrap": "history",
-    "dataSource": "commits",
-    "ignoreIssuesWith": [
-        "wontfix",
-        "duplicate"
-    ]
-}
+```shell
+gren --username=[username] --repo=[repo name]
 ```
 
-The accepted file extensions are the following:
+To use a specific token you can specify it as option:
 
-- `.grenrc`
-- `.grenrc.json`
-- `.grenrc.yml`
-- `.grenrc.yaml`
-- `.grenrc.js`
-
-#### Templates
-
-You can configure the output of **gren** using templates. Set your own configuration inside the config file, which will be merged with the defaults, shown below:
-
-```json
-{
-    "template": {
-        "commit": "- {{message}}",
-        "issue": "- {{labels}} {{name}} {{link}}",
-        "issueInfo": {
-            "labels": "{{labels}}",
-            "label": "[**{{label}}**]",
-            "name": "{{name}}",
-            "link": "[{{text}}]({{url}})"
-        },
-        "release": "## {{release}} {{date}}",
-        "releaseInfo": {
-            "release": "{{release}}",
-            "date": "({{date}})"
-        }
-    }
-}
-```
-
-## Examples
-
-The ways to use **gren** are various.
-
-### Simple
-
-The simple way, just looks for the last tag, gets all the issues closed between that tag and the one before and creates the new release with the generated body.
-
-```
-gren
-```
-
-### Commit messages
-
-Adding the flag `--data-source=commits` will change the source of the release notes to be the commit messages.
-
-```
-gren --data-source=commits
-```
-
-### Release specific tags
-
-The flag `--tags` accepts one or two tags.
-If you only give one tag, it will get the issues (or commit messages) between that tag and the one before.
-If you give two tags it will generate the release notes with the issues (or commit messages) between those two tag dates.
-
-```
-gren --tags=2.0.0,1.0.0
-```
-
-### Override an existing release
-
-If you trying to create an existing release, **gren** will throw an error *"0.3.0 is a release, use --override flag to override an existing release!*
-If you want then to override, simple use:
-
-```
-gren --override --tags=0.3.0
-```
-
-### Write all existing tags
-
-You can run the task to generate release notes for all existing tags.
-Releases that already exist will be skipped. To override them, use the flag `--override`
-
-```
-gren --override --tags=all
-```
-
-## Changelog Generator
-
-**gren** can also update generate the changelog.
-
-The following command, will get the latest release notes, and add it to an existing file or create it in the same directory where you run the command.
-
 ```shell
-gren --action=changelog
+gren --token=[your token]
 ```
 
-The generated release notes will be added at the top of the file, and will look like this:
+### Demo
 
-> # Changelog
-##  v0.4.3 (02/03/2016)
-[**bug**] This is a issue name [#123](https://github.com/github-tools/github-tools)
+![gren demo](./docs/images/examples/exec_gren.gif)
 
-### Generate a full changelog
+### Actions
 
-If tou want to generate the whole changelog, you need to use the `--time-wrap=history`. This will generate the changelog based on all release notes.
+**Gren** has two main usages: `release` and `changelog`.
+You can select the action with the `--action` option.
 
-If you want to override the existing changelog, use `--override`. This will also generate the release notes from scratch.
-
-The usage would then be:
-
-```
-gren --action=changelog --time-wrap=history --override
-```
-
-To see a full example of the changelog here [CHANGELOG.md](https://github.com/github-tools/github-release-notes/blob/develop/CHANGELOG.md)
-
----
-
-## JavaScript documentation
-
-Find the full documentation for JavaScript function here: [http://github-tools.github.io/github-release-notes/](http://github-tools.github.io/github-release-notes/)
+[See full documentation here](https://github-tools.github.io/github-release-notes)

src/gren.js

@@ -12,3 +12,3 @@ 'use strict';
 var templateConfig = require('./templates.json');
-var ObjectAssign = require('deep-assign');
+var ObjectAssign = require('object-assign-deep');
 var configFile = utils.getConfigFromFile(process.cwd());
@@ -334,3 +334,3 @@
                 label: label.name
-            }, gren.options.template.issueInfo.label);
+            }, gren.options.template.label);
         }).join('');
@@ -354,3 +354,3 @@ }
         date: utils.formatDate(date)
-    }, template.generate(gren.options.template.releaseInfo, gren.options.template.release));
+    }, gren.options.template.release);
 
@@ -371,13 +371,8 @@ return releaseTemplate + '\n\n' + block.body;
 function templateIssue(gren, issue) {
-    var issueTemplate = template.generate(gren.options.template.issueInfo, gren.options.template.issue);
-    var nameTemplate = template.generate({
-        name: issue.title
-    }, gren.options.template.issueInfo.name);
-
     return template.generate({
         labels: templateLabels(gren, issue),
-        name: nameTemplate,
+        name: issue.title,
         text: '#' + issue.number,
         url: issue.html_url
-    }, issueTemplate);
+    }, gren.options.template.issue);
 }
@@ -384,0 +379,0 @@

src/template.js

 'use strict';
 
+/**
+ * Generate the templated string based on
+ * a placeholders Object
+ *
+ * @since  0.6.0
+ * @private
+ *
+ * @param  {Object} placeholders All the keys/values to update
+ * @param  {string|Function} string The string or the function that needs to be replaced
+ *
+ * @return {string}
+ */
 function generate(placeholders, string) {
+    if (typeof string === 'function') {
+        return string(placeholders);
+    }
+
     return Object.keys(placeholders)
@@ -5,0 +21,0 @@ .reduce(function(carry, placeholder) {

src/templates.json

 {
     "commit": "- {{message}}",
-    "issue": "- {{labels}} {{name}} {{link}}",
-    "issueInfo": {
-        "labels": "{{labels}}",
-        "label": "[**{{label}}**]",
-        "name": "{{name}}",
-        "link": "[{{text}}]({{url}})"
-    },
-    "release": "## {{release}} {{date}}",
-    "releaseInfo": {
-        "release": "{{release}}",
-        "date": "({{date}})"
-    }
+    "issue": "- {{labels}} {{name}} [{{text}}]({{url}})",
+    "label": "[**{{label}}**]",
+    "release": "## {{release}} {{date}}"
 }

src/utils.js

@@ -187,3 +187,3 @@ 'use strict';
     if (filepath.match(/\./g).length === 1) {
-        return JSON.parse(fs.readFileSync(filepath, "utf8"));
+        return JSON.parse(fs.readFileSync(filepath, 'utf8'));
     }
@@ -205,11 +205,11 @@
     return [
-            '.grenrc.yml',
-            '.grenrc.json',
-            '.grenrc.yaml',
-            '.grenrc.js',
-            '.grenrc'
-        ]
-        .reduce(function(carry, filename) {
-            return carry || requireConfig(path + '/' + filename);
-        }, false) || {};
+        '.grenrc.yml',
+        '.grenrc.json',
+        '.grenrc.yaml',
+        '.grenrc.js',
+        '.grenrc'
+    ]
+    .reduce(function(carry, filename) {
+        return carry || requireConfig(path + '/' + filename);
+    }, false) || {};
 }
@@ -216,0 +216,0 @@

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

Dependency count

5

decreased by-16.67%

Worsened metrics

Total package byte prevSize

39634

decreased by-17.2%

Dev dependency count

10

increased by11.11%

Number of package files

12

decreased by-36.84%

Lines of code

1154

decreased by-4.55%

Number of lines in readme file

60

decreased by-73.21%

Dependency changes

• - Removeddeep-assign@^2.0.0

• - Removeddeep-assign@2.0.0(transitive)

• - Removedis-obj@1.0.1(transitive)