Merge pull request #1 from nomi9995/feat/changelog

feat: add changelog template

Author: numandev1

README.md

@@ -12,7 +12,9 @@
 
 Generate release notes from git commit history either **commit range** or **tag range**.
 
-![](media/appstore.png)
+| ![](media/appstore.png) | ![](media/changeLog.png) |
+| :---------------------: | :----------------------: |
+|   App Store Template    |    Changelog Template    |
 
 ### Installation
 
@@ -43,6 +45,7 @@ Where
 Three sample templates are included as a reference in the `templates` folder
 
 - `appstore` [(sample)](https://github.com/nomi9995/release-notes-cli/blob/master/samples/output-appstore.txt)
+- `changelog` [(sample)](https://github.com/nomi9995/release-notes-cli/blob/master/samples/output-changelog.md)
 - `markdown` [(sample)](https://github.com/nomi9995/release-notes-cli/blob/master/samples/output-markdown.md)
 - `html` [(sample)](http://htmlpreview.github.io/?https://github.com/nomi9995/release-notes-cli/blob/master/samples/output-html.html)
 - `html-bootstrap` [(sample)](http://htmlpreview.github.io/?https://github.com/nomi9995/release-notes-cli/blob/master/samples/output-html-bootstrap.html)
@@ -69,6 +72,23 @@ fix(server): send cors headers
 feat(blog): add comment section
 ```
 
+#### Changelog Template
+
+You need to get **GitHub personal** access token from github for setting committer username like this: [@nomi9995](https://github.com/nomi9995)
+
+Since `release-notes-cli` interacts with the GitHub API you may run into rate
+limiting issues which can be resolved by supplying a "personal access token":
+
+```
+export GITHUB_AUTH="..."
+```
+
+You'll need a [personal access token](https://github.com/settings/tokens)
+for the GitHub API with the `repo` scope for private repositories or just
+`public_repo` scope for public repositories.
+
+**Note:** if you dont set `GITHUB_AUTH` then it will not print committer username for all commits, it will print email instead of github username
+
 #### Custom template
 
 The second parameter of `release-notes-cli` can be any path to a valid ejs template files.

media/appstore.png

@@ -11,6 +11,10 @@
   },
   "keywords": [
     "git",
+    "markdown",
+    "changelog",
+    "changelog-generator",
+    "commitlint",
     "log",
     "release notes",
     "compare",
@@ -39,11 +43,13 @@
     "watch": "yarn build -- --watch"
   },
   "dependencies": {
+    "@octokit/rest": "^19.0.4",
     "chalk": "4.1.2",
     "clipboardy": "2.3.0",
     "date-fns": "^2.29.2",
     "debug": "^4.3.4",
     "ejs": "^3.1.8",
+    "gitconfiglocal": "^2.1.0",
     "yargs": "^17.1.0"
   },
   "devDependencies": {

media/bootstrap.png

@@ -0,0 +1,15 @@
+###Others
+
+- release 1.5.2 ([bccb6f28fd](https://github.com/Shobbak/react-native-compressor/commit/bccb6f28fdeecd0915f12fbe990b9b170217ff90) by [@nomi9995](https://github.com/nomi9995))
+- release 1.5.1 ([f58a268b0b](https://github.com/Shobbak/react-native-compressor/commit/f58a268b0bfb940a34b1643080b28e6339417169) by [@nomi9995](https://github.com/nomi9995))
+- release 1.5.0 ([e696968913](https://github.com/Shobbak/react-native-compressor/commit/e696968913cf0aa1a309345b0e75e38695be1516) by [@nomi9995](https://github.com/nomi9995))
+- release 1.4.0 ([30b7bedd78](https://github.com/Shobbak/react-native-compressor/commit/30b7bedd78d22ab6096dfed04895fcc5e94bbf49) by [@nomi9995](https://github.com/nomi9995))
+
+###docs
+
+- update table of content ([b77bdb2105](https://github.com/Shobbak/react-native-compressor/commit/b77bdb21058187c13eef7ad9942b870e815538e7) by [@nomi9995](https://github.com/nomi9995))
+- update docs ([8321e362d3](https://github.com/Shobbak/react-native-compressor/commit/8321e362d3adc1cd341130e1bf7b5039109330ac) by [@nomi9995](https://github.com/nomi9995))
+
+###Features
+
+- add getVideoMetaData function for video metadata ([490c8cb884](https://github.com/Shobbak/react-native-compressor/commit/490c8cb88489dc7201a57ba213642a3121c1b203) by [@nomi9995](https://github.com/nomi9995))

media/changeLog.png

@@ -7,6 +7,7 @@ let dateFnsFormat = require("date-fns/format");
 import type { OPTIONS, ICommit } from "./types";
 import * as clipboard from "clipboardy";
 import chalk = require("chalk");
+const githubUsername = require("./utils/github-username");
 
 export default (cliOptions: OPTIONS, positionalRange: string, positionalTemplate: string = "appstore") => {
   return fileSystem.resolveTemplate(positionalTemplate).then((template: string) => {
@@ -33,7 +34,7 @@ export default (cliOptions: OPTIONS, positionalRange: string, positionalTemplate
   });
 };
 
-const render = (
+const render = async (
   range: string,
   templateContent: string,
   data: any,
@@ -42,16 +43,45 @@ const render = (
 ) => {
   debug("Rendering template");
   let renderedContent = "";
-  if (type === "appstore") {
+  if (type === "appstore" || type === "changelog") {
+    let gitRemote = "";
+    let isError = false;
     const allCommits: { [key: string]: ICommit } = commitFormateForAppstore(data.commits);
-    for (let [key, value] of Object.entries(allCommits)) {
-      renderedContent += ejs.render(templateContent, { title: key, commits: value }) + "\n";
+    if (type === "changelog") {
+      gitRemote = await git.gitRemoteOriginUrl();
+      for (let [key, value] of Object.entries(allCommits)) {
+        //@ts-ignore
+        const valueCommits: ICommit[] = value;
+        const x = valueCommits.map(async commit => {
+          try {
+            const username = await githubUsername(commit.committerEmail, { token: process.env.GITHUB_AUTH });
+            //@ts-ignore
+            commit.username = username;
+          } catch (error) {
+            isError = true;
+          }
+        });
+        await Promise.all(x);
+
+        renderedContent += ejs.render(templateContent, { title: key, gitRemote, commits: valueCommits }) + "\n";
+      }
+    } else {
+      for (let [key, value] of Object.entries(allCommits)) {
+        renderedContent += ejs.render(templateContent, { title: key, commits: value }) + "\n";
+      }
     }
     console.log(chalk.magentaBright(renderedContent));
     if (copy) {
       clipboard.writeSync(renderedContent);
       console.log(chalk.green("Copied to clipboard successfully\n"));
     }
+    if (isError) {
+      console.log(
+        chalk.red(
+          'You need to get personal access token from github for setting committer username like this:\n\nexport GITHUB_AUTH="..."'
+        )
+      );
+    }
     return;
   }
 
@@ -94,7 +124,7 @@ const commitLintTypesMapper: string[] = [
   "Features",
   "Fixes",
   "perf",
-  "Fixes",
+  "Changed",
   "revert",
   "style",
   "test",

package.json

@@ -1,6 +1,9 @@
 //@ts-ignore
 let debug = require("debug")("release-notes:git");
 let parser = require("debug")("release-notes:parser");
+const gitconfig = require("gitconfiglocal");
+const { promisify } = require("util");
+const pGitconfig = promisify(gitconfig);
 
 exports.log = function (options: any) {
   return new Promise(function (resolve, reject) {
@@ -156,3 +159,10 @@ function parseTag(line: string) {
 function normalizeNewlines(message: string) {
   return message.replace(/\r\n?|[\n\u2028\u2029]/g, "\n").replace(/^\uFEFF/, "");
 }
+
+export async function gitRemoteOriginUrl({ cwd = process.cwd(), remoteName = "origin" } = {}) {
+  const config = await pGitconfig(cwd);
+  const url: string = (config.remote && config.remote[remoteName] && config.remote[remoteName].url) || "";
+
+  return url.replace(/\.git$/, "");
+}

samples/output-changelog.md

@@ -0,0 +1,38 @@
+const { Octokit } = require("@octokit/rest");
+
+async function searchCommits(octokit: any, email: string) {
+  const { data } = await octokit.search.commits({
+    q: `author-email:${email}`,
+    sort: "author-date",
+    // eslint-disable-next-line camelcase
+    per_page: 1,
+  });
+
+  if (data.total_count === 0) {
+    throw new Error(`Couldn't find username for \`${email}\``);
+  }
+
+  return data.items[0].author.login;
+}
+
+//@ts-ignore
+module.exports = async function githubUsername(email: string, { token } = {}) {
+  if (!(typeof email === "string" && email.includes("@"))) {
+    throw new Error("Email required");
+  }
+
+  const octokit = new Octokit({
+    auth: token,
+    userAgent: "https://github.com/nomi9995/github-username",
+  });
+
+  const { data } = await octokit.search.users({
+    q: `${email} in:email`,
+  });
+
+  if (data.total_count === 0) {
+    return searchCommits(octokit, email);
+  }
+
+  return data.items[0].login;
+};

src/index.ts

@@ -0,0 +1,5 @@
+###<%= title -%>
+
+<% commits.forEach(function (commit) { -%>
+-<%= commit.title -%> ([<%= commit.sha1.slice(0,10) -%>](<%= gitRemote -%>/commit/<%= commit.sha1 -%>) by [@<%= commit.username?commit.username:commit.committerEmail-%>](https://github.com/<%= commit.username?commit.username:commit.committerEmail-%>))
+<% }) -%>

src/utils/git.ts

@@ -687,6 +687,13 @@
   dependencies:
     "@octokit/types" "^6.41.0"
 
+"@octokit/plugin-paginate-rest@^4.0.0":
+  version "4.1.0"
+  resolved "https://registry.yarnpkg.com/@octokit/plugin-paginate-rest/-/plugin-paginate-rest-4.1.0.tgz#670ac9ac369448c69a2371bfcd7e2b37d95534f2"
+  integrity sha512-2O5K5fpajYG5g62wjzHR7/cWYaCA88CextAW3vFP+yoIHD0KEdlVMHfM5/i5LyV+JMmqiYW7w5qfg46FR+McNw==
+  dependencies:
+    "@octokit/types" "^7.1.1"
+
 "@octokit/plugin-request-log@^1.0.4":
   version "1.0.4"
   resolved "https://registry.yarnpkg.com/@octokit/plugin-request-log/-/plugin-request-log-1.0.4.tgz#5e50ed7083a613816b1e4a28aeec5fb7f1462e85"
@@ -731,14 +738,24 @@
     "@octokit/plugin-request-log" "^1.0.4"
     "@octokit/plugin-rest-endpoint-methods" "^6.0.0"
 
+"@octokit/rest@^19.0.4":
+  version "19.0.4"
+  resolved "https://registry.yarnpkg.com/@octokit/rest/-/rest-19.0.4.tgz#fd8bed1cefffa486e9ae46a9dc608ce81bcfcbdd"
+  integrity sha512-LwG668+6lE8zlSYOfwPj4FxWdv/qFXYBpv79TWIQEpBLKA9D/IMcWsF/U9RGpA3YqMVDiTxpgVpEW3zTFfPFTA==
+  dependencies:
+    "@octokit/core" "^4.0.0"
+    "@octokit/plugin-paginate-rest" "^4.0.0"
+    "@octokit/plugin-request-log" "^1.0.4"
+    "@octokit/plugin-rest-endpoint-methods" "^6.0.0"
+
 "@octokit/types@^6.41.0":
   version "6.41.0"
   resolved "https://registry.yarnpkg.com/@octokit/types/-/types-6.41.0.tgz#e58ef78d78596d2fb7df9c6259802464b5f84a04"
   integrity sha512-eJ2jbzjdijiL3B4PrSQaSjuF2sPEQPVCPzBvTHJD9Nz+9dw2SGH4K4xeQJ77YfTq5bRQ+bD8wT11JbeDPmxmGg==
   dependencies:
     "@octokit/openapi-types" "^12.11.0"
 
-"@octokit/types@^7.0.0":
+"@octokit/types@^7.0.0", "@octokit/types@^7.1.1":
   version "7.1.1"
   resolved "https://registry.yarnpkg.com/@octokit/types/-/types-7.1.1.tgz#a30fd6ca3279d59d532fa75583d65d93b7588e6d"
   integrity sha512-Dx6cNTORyVaKY0Yeb9MbHksk79L8GXsihbG6PtWqTpkyA2TY1qBWE26EQXVG3dHwY9Femdd/WEeRUEiD0+H3TQ==
@@ -2399,6 +2416,13 @@ git-url-parse@12.0.0:
   dependencies:
     git-up "^6.0.0"
 
+gitconfiglocal@^2.1.0:
+  version "2.1.0"
+  resolved "https://registry.yarnpkg.com/gitconfiglocal/-/gitconfiglocal-2.1.0.tgz#07c28685c55cc5338b27b5acbcfe34aeb92e43d1"
+  integrity sha512-qoerOEliJn3z+Zyn1HW2F6eoYJqKwS6MgC9cztTLUB/xLWX8gD/6T60pKn4+t/d6tP7JlybI7Z3z+I572CR/Vg==
+  dependencies:
+    ini "^1.3.2"
+
 glob-parent@^5.1.2:
   version "5.1.2"
   resolved "https://registry.yarnpkg.com/glob-parent/-/glob-parent-5.1.2.tgz#869832c58034fe68a4093c17dc15e8340d8401c4"
@@ -2659,7 +2683,7 @@ ini@2.0.0:
   resolved "https://registry.yarnpkg.com/ini/-/ini-2.0.0.tgz#e5fd556ecdd5726be978fa1001862eacb0a94bc5"
   integrity sha512-7PnF4oN3CvZF23ADhA5wRaYEQpJ8qygSkbtTXWBeXWXmEVRXK+1ITciHWwHhsjv1TmW0MgacIv6hEi5pX5NQdA==
 
-ini@^1.3.4, ini@~1.3.0:
+ini@^1.3.2, ini@^1.3.4, ini@~1.3.0:
   version "1.3.8"
   resolved "https://registry.yarnpkg.com/ini/-/ini-1.3.8.tgz#a29da425b48806f34767a4efce397269af28432c"
   integrity sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew==