|
| 1 | +// TODO: test git push |
| 2 | +// TODO: early exit based on last changelog version |
| 3 | +// TODO: 'Authorization': 'token xxxx', for testing |
| 4 | +// TODO: add npm run changelog to pre push |
| 5 | +// TODO: uncomment functions |
| 6 | + |
| 7 | +(function () { |
| 8 | + // libs |
| 9 | + 'use strict' |
| 10 | + var path = require('path') |
| 11 | + // var exec = require('child_process').exec |
| 12 | + var fileHelper = require('../lib/fileHelper.js') |
| 13 | + var request = require('request') |
| 14 | + var FILE = path.join(__dirname, '../../../', 'CHANGELOG.md') |
| 15 | + |
| 16 | + // properties |
| 17 | + var apiURL = 'https://api.github.com/repos/' |
| 18 | + var gitURL = 'https://github.com/' |
| 19 | + var baseURL = 'BranchMetrics/cordova-ionic-phonegap-branch-deep-linking/' |
| 20 | + var tagsURL = apiURL + baseURL + 'tags' |
| 21 | + var issuesURL = apiURL + baseURL + 'issues' |
| 22 | + var commitsURL = apiURL + baseURL + 'commits' |
| 23 | + |
| 24 | + // entry |
| 25 | + module.exports = updateChangeLog() |
| 26 | + |
| 27 | + function updateChangeLog () { |
| 28 | + var pageLimit = isReset() ? 50 : 2 |
| 29 | + var tags = new Promise(function (resolve, reject) { |
| 30 | + readData(tagsURL, [], 1, pageLimit, function (values) { |
| 31 | + resolve(values) |
| 32 | + }) |
| 33 | + }) |
| 34 | + var issues = new Promise(function (resolve, reject) { |
| 35 | + readData(issuesURL, [], 1, pageLimit, function (values) { |
| 36 | + resolve(values) |
| 37 | + }) |
| 38 | + }) |
| 39 | + var commits = new Promise(function (resolve, reject) { |
| 40 | + readData(commitsURL, [], 1, pageLimit, function (values) { |
| 41 | + resolve(values) |
| 42 | + }) |
| 43 | + }) |
| 44 | + |
| 45 | + Promise.all([tags, issues, commits]).then(function (values) { |
| 46 | + var markdown = generateMarkdown(values) |
| 47 | + fileHelper.writeFile(FILE, markdown) |
| 48 | + // commitChanges() |
| 49 | + }) |
| 50 | + } |
| 51 | + |
| 52 | + function isReset () { |
| 53 | + var args = process.argv.slice(2) |
| 54 | + for (var i = 0; i < args.length; i++) { |
| 55 | + var arg = args[i] |
| 56 | + if (arg === '-reset=true') { |
| 57 | + return true |
| 58 | + } |
| 59 | + } |
| 60 | + return false |
| 61 | + } |
| 62 | + |
| 63 | + function readData (url, data, page, pageLimit, callback) { |
| 64 | + var link = url + '?page=' + page |
| 65 | + link += (url.indexOf('issues') > 0) ? '&state=closed' : '' |
| 66 | + |
| 67 | + readGit(link, function (values) { |
| 68 | + data.push.apply(data, values) |
| 69 | + if (values.length === 0 || page >= pageLimit) { |
| 70 | + callback(data) |
| 71 | + } else { |
| 72 | + page += 1 |
| 73 | + readData(url, data, page, pageLimit, callback) |
| 74 | + } |
| 75 | + }) |
| 76 | + } |
| 77 | + |
| 78 | + function readGit (url, callback) { |
| 79 | + var options = { |
| 80 | + method: 'GET', |
| 81 | + url: url, |
| 82 | + headers: { |
| 83 | + 'User-Agent': 'branch-cordova-sdk', |
| 84 | + 'cache-control': 'no-cache' |
| 85 | + } |
| 86 | + } |
| 87 | + request(options, function (error, response, body) { |
| 88 | + if (response.statusCode === 200) { |
| 89 | + callback(JSON.parse(body)) |
| 90 | + } else { |
| 91 | + throw new Error(JSON.parse(error || body)) |
| 92 | + } |
| 93 | + }) |
| 94 | + } |
| 95 | + |
| 96 | + function generateMarkdown (values) { |
| 97 | + // 3/2(O)n (swap) |
| 98 | + var tags = values[0].reverse() |
| 99 | + var issues = values[1].reverse() |
| 100 | + var commits = values[2].reverse() |
| 101 | + |
| 102 | + var output = getHeader() |
| 103 | + |
| 104 | + // (O)n (tags) |
| 105 | + var tagParagraph = '' |
| 106 | + while (tags.length > 0) { |
| 107 | + var currentTag = tags.pop() |
| 108 | + |
| 109 | + tagParagraph += getTagHeader(currentTag) |
| 110 | + tagParagraph += getCommitParagraph(currentTag, commits) |
| 111 | + tagParagraph += getIssueParagraph(currentTag, issues) |
| 112 | + |
| 113 | + output += tagParagraph |
| 114 | + tagParagraph = '' |
| 115 | + } |
| 116 | + |
| 117 | + return output |
| 118 | + } |
| 119 | + |
| 120 | + function getHeader () { |
| 121 | + return '# CHANGELOG\nQuestions? [Contact us](https://support.branch.io/support/tickets/new)\n\n' |
| 122 | + } |
| 123 | + |
| 124 | + function getTagHeader (currentTag) { |
| 125 | + return '## [' + currentTag.name + '](' + gitURL + baseURL + 'releases/tag/' + currentTag.name + ') ' |
| 126 | + } |
| 127 | + |
| 128 | + function getCommitParagraph (currentTag, commits) { |
| 129 | + var body = '\n\n' |
| 130 | + if (commits.length === 0) { |
| 131 | + return body |
| 132 | + } |
| 133 | + |
| 134 | + // (O)n (commits) |
| 135 | + var paragraph = '' |
| 136 | + var hasHeader = false |
| 137 | + while (commits.length > 0) { |
| 138 | + var current = commits.pop() |
| 139 | + |
| 140 | + // (O)n (commit messages) |
| 141 | + var message = current.commit.message.replace(/(\r\n|\n|\r)/gm, '') |
| 142 | + |
| 143 | + if (!hasHeader) { |
| 144 | + paragraph += '- **Completed Changes**\n' |
| 145 | + hasHeader = true |
| 146 | + } |
| 147 | + |
| 148 | + paragraph += ' - ' + message + ' ([' + current.sha.substr(0, 5) + '](' + current.html_url + '))\n' |
| 149 | + |
| 150 | + if (currentTag.commit.sha === current.sha) { |
| 151 | + // assign date to be used for header and issues conditional |
| 152 | + var date = current.commit.author.date |
| 153 | + currentTag.date = date |
| 154 | + |
| 155 | + // complete body |
| 156 | + body = '' |
| 157 | + body += '(' + date.substr(0, 10) + ')\n\n' |
| 158 | + body += paragraph + '\n' |
| 159 | + break |
| 160 | + } |
| 161 | + } |
| 162 | + return body |
| 163 | + } |
| 164 | + |
| 165 | + function getIssueParagraph (currentTag, issues) { |
| 166 | + var body = '' |
| 167 | + if (issues.length === 0) { |
| 168 | + return body |
| 169 | + } |
| 170 | + |
| 171 | + // (O)n (issues) |
| 172 | + var paragraph = '' |
| 173 | + var hasHeader = false |
| 174 | + while (issues.length > 0) { |
| 175 | + var current = issues.pop() |
| 176 | + |
| 177 | + if (!current.hasOwnProperty('pull_request')) { |
| 178 | + if (!hasHeader) { |
| 179 | + paragraph += '- **Closed Issues**\n' |
| 180 | + hasHeader = true |
| 181 | + } |
| 182 | + |
| 183 | + paragraph += ' - ' + current.title.replace(/(\r\n|\n|\r)/gm, '') + ' ([#' + current.number + '](' + current.html_url + '))\n' |
| 184 | + } |
| 185 | + |
| 186 | + if (new Date(current.closed_at).getTime() < new Date(currentTag.date).getTime() && hasHeader) { |
| 187 | + body += paragraph + '\n' |
| 188 | + break |
| 189 | + } |
| 190 | + } |
| 191 | + |
| 192 | + return body |
| 193 | + } |
| 194 | + |
| 195 | + // only show conventional-commit-types |
| 196 | + // function isValidCommitMessage (message) { |
| 197 | + // var commitMessages = ['feat:', 'fix:', 'docs:', 'style:', 'refactor:', 'perf:', 'test:', 'chore:', 'revert:'] |
| 198 | + // for (var i = 0; i < commitMessages.length; i++) { |
| 199 | + // var commitMessage = commitMessages[i] |
| 200 | + // if (message.indexOf(commitMessage) === 0) { |
| 201 | + // return true |
| 202 | + // } |
| 203 | + // } |
| 204 | + // return false |
| 205 | + // } |
| 206 | + |
| 207 | + // push file code changes to github |
| 208 | + // function commitChanges () { |
| 209 | + // var git = 'git add ' + FILE + ' && git add git commit -m "chore: updated changelog" && git push' |
| 210 | + // git = 'echo' |
| 211 | + // exec(git, function (err, stdout, stderr) { |
| 212 | + // if (err) { |
| 213 | + // throw new Error('BRANCH SDK: Failed cto ommit git changes for changelog. Docs https://goo.gl/GijGKP') |
| 214 | + // } |
| 215 | + // }) |
| 216 | + // } |
| 217 | +})() |
0 commit comments