├── .eslintrc ├── .gitignore ├── LICENSE ├── README.md ├── bin └── main.js ├── lib ├── git.js ├── logger.js ├── render.js └── validator.js ├── package-lock.json └── package.json /.eslintrc: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "airbnb-base", 3 | "env": { 4 | "node": true, 5 | "es6": true 6 | }, 7 | "rules": { 8 | "object-shorthand": "off", 9 | "arrow-parens": ["error", "always"], 10 | "comma-dangle": ["error", "never"], 11 | "no-shadow": ["off", { "hoist": "never", "builtinGlobals": true }], 12 | "max-len": ["off", 120], 13 | "array-bracket-spacing": ["off", "never"], 14 | "object-property-newline": "off", 15 | "no-sequences": "off", 16 | "no-param-reassign": ["error", { "props": false }], 17 | "no-unused-expressions": ["error", { "allowShortCircuit": true }], 18 | "padded-blocks": ["off", "always"], 19 | "arrow-body-style": ["off", "as-needed"], 20 | "no-use-before-define": ["error", { "functions": false, "classes": true }], 21 | "new-cap": ["error", { "properties": true, "capIsNewExceptionPattern": "^Awesomplete." }], 22 | "no-mixed-operators": ["error", {"groups": [["&", "|", "^", "~", "<<", ">>", ">>>"], ["&&", "||"]]}], 23 | "no-return-assign": "off", 24 | "consistent-return": "off", 25 | "default-case": "off", 26 | "no-plusplus": "off", 27 | "no-bitwise": "off", 28 | "no-debugger": "off", 29 | "prefer-template": "off", 30 | "class-methods-use-this": "off", 31 | "func-names": ["off", "never"], 32 | "prefer-destructuring": "off", 33 | "function-paren-newline": "off", 34 | "prefer-promise-reject-errors": "off", 35 | "no-console": "off", 36 | "object-curly-newline": "off", 37 | "space-before-function-paren": "off", 38 | "global-require": "off", 39 | "indent": "off" 40 | } 41 | } 42 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .cache 2 | .DS_Store 3 | .forever 4 | .node-gyp 5 | .npm 6 | node_modules 7 | npm-debug.log 8 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2018 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # releaser 2 | 3 | A release note generator that reads and parses git commits and retrieves issue links from GitHub. 4 | 5 | ## Usage 6 | 7 | `releaser --dir --upstream / --token ` 8 | 9 | ## Arguments 10 | 11 | ``` 12 | --config [value] configuration file in js 13 | --dir read commits and tags from this local git directory 14 | --upstream GitHub / 15 | --token GitHub token 16 | --tag [value] get changelog from this tag 17 | --type [value] Type of new release (semver) 18 | -h, --help output usage information 19 | ``` 20 | 21 | ## Git 22 | By default, it expects the commits and tags to follow a specific format. 23 | 24 | ### Tags 25 | Tags are expected to follow the semver convention as `v1.0.0`. It is customizable through the `tagRegex` configuration option. 26 | 27 | ### Commits 28 | Commits are expected to follow the following convention: 29 | 30 | * `/(Fix|Close|Resolve) #(\d+)/g `: A commit name that matches this regex will automatically be resolved to the corresponding GitHub issue with the title of the issue as the name of the change. This is overridable through the `issueRegex` parameter in a configuration file. 31 | * `Hotfix - Message`: A commit name that starts with `Hotfix` will get included as `others` with Message as the name of the change. This is customisable through the `labels > local` parameter in a configuration file. 32 | 33 | ### Issue labels 34 | By default, only issues that contain the labels `[Bug, Feature]` will be included in the release notes. This is customisable through the `externalLabels` parameter in a configuration file. 35 | 36 | ## Render 37 | By default, the changelog is rendered in markdown. It is possible to override the rendering functions through the configuration file. 38 | 39 | ## Configuration 40 | Example `releaser.config.js`: 41 | 42 | ```javascript 43 | module.exports = { 44 | upstream: 'ProtonMail/WebClient', 45 | dir: '.', 46 | rotate: 5, 47 | tagRegex: 'v\d+.\d+.\d+', 48 | labels: { 49 | external: [{ match: 'Enhancement', name: 'Features' }, { match: 'Bug', name: 'Bugs' }], 50 | local: [{ match: /Hotfix [-~]? ?/, name: 'Others' }] 51 | }, 52 | render: { 53 | commit: function commit({ title, issueNumber, name }) { 54 | const issue = (number) => number && `#${number} ` || ''; 55 | return `* ${issue(issueNumber)}${title || name}`; 56 | } 57 | } 58 | }; 59 | 60 | ``` 61 | 62 | ## Author 63 | 64 | Mattias Svanström (@mmso) - ProtonMail 65 | -------------------------------------------------------------------------------- /bin/main.js: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | 3 | const path = require('path'); 4 | const _ = require('lodash'); 5 | const commander = require('commander'); 6 | const fs = require('fs'); 7 | const validator = require('../lib/validator'); 8 | const git = require('../lib/git'); 9 | const render = require('../lib/render'); 10 | const Logger = require('../lib/logger'); 11 | const semver = require('semver'); 12 | 13 | const getNextVersion = (fromTagName, type) => { 14 | const [, currentTag ] = fromTagName.split('v'); 15 | const nextVersion = semver.inc(currentTag, type); 16 | return `v${nextVersion}`; 17 | }; 18 | 19 | /** 20 | * Run the main program. 21 | * @param {string} owner GitHub owner 22 | * @param {string} repo GitHub repo 23 | * @param {string} token GitHub token 24 | * @param {string} dir Git directory 25 | * @param {RegExp} issueRegex Regex to match external issues 26 | * @param {string} tag Name to start from 27 | * @param {RegExp} tagRegex Regex to tags 28 | * @param {Array} externalLabels External commit labels 29 | * @param {Array} localLabels Local commit labels 30 | * @param {Object} render Render functions. 31 | * @param {Object} logger Logger functions. 32 | * @param {String} type Type of release (semver) 33 | * @returns {Promise} 34 | */ 35 | async function main({ owner, repo, token, dir, issueRegex, tag, tagRegex, externalLabels, localLabels, render, logger, type }) { 36 | logger.progress(`Loading ${dir}`); 37 | 38 | // Get all tags. 39 | const { commits, from: fromTag, to: toTag } = await git.read({ dir, tag, tagRegex }); 40 | 41 | logger.success(`Found tags from ${fromTag.name} ${fromTag.date} to ${toTag.name} ${toTag.date}`); 42 | logger.success(`With ${commits.length} commits`); 43 | 44 | const { groupedCommits, issues } = await git.retrieve({ 45 | commits, 46 | issueRegex, 47 | owner, 48 | repo, 49 | token, 50 | externalLabels, 51 | localLabels, 52 | logger 53 | }); 54 | 55 | for (let i = 0; i < groupedCommits.length; ++i) { 56 | const { commits, name } = groupedCommits[i]; 57 | logger.success(`${commits.length} ${name} fixed`); 58 | } 59 | 60 | const { date, name: fromVersion } = fromTag; 61 | 62 | const data = render.all({ 63 | version: type ? getNextVersion(fromVersion, type) : fromVersion, 64 | date, 65 | issues, 66 | groupedCommits, 67 | render 68 | }); 69 | 70 | process.stdout.write(data); 71 | } 72 | 73 | /** 74 | * Reads a configuration file from a specified pathname. 75 | * @param {string} pathname 76 | * @returns {Object} 77 | */ 78 | function readConfiguration(pathname) { 79 | if (!pathname) { 80 | return {}; 81 | } 82 | const resolvedPathname = path.resolve(pathname); 83 | const fail = () => { 84 | console.error(`configuration file ${resolvedPathname} needs to be a valid js file`); 85 | process.exit(1); 86 | }; 87 | if (!pathname.endsWith('.js')) { 88 | fail(); 89 | } 90 | try { 91 | // eslint-disable-next-line import/no-dynamic-require 92 | const data = require(resolvedPathname); 93 | if (!_.isObject(data)) { 94 | fail(); 95 | } 96 | return data; 97 | } catch (e) { 98 | fail(); 99 | } 100 | } 101 | 102 | /** 103 | * Parses a list of arguments. 104 | * @param {Array} argv 105 | * @returns {Object} Parsed args. 106 | */ 107 | function parseCmd(argv) { 108 | commander 109 | .version('0.1.0') 110 | .option('--config [value]', 'configuration file in js') 111 | .option('--dir ', 'read commits and tags from this local git directory') 112 | .option('--upstream ', 'GitHub /') 113 | .option('--token [value]', 'GitHub token') 114 | .option('--verbosity [value]', 'verbosity level', (val) => parseInt(val, 10)) 115 | .option('--tag [value]', 'get changelog from this tag') 116 | .option('--type [value]', 'Type of new release (semver)') 117 | .parse(argv); 118 | 119 | const defaults = { 120 | issueRegex: /(Fix|Close|Resolve) #(\d+)/g, 121 | tagRegex: /v\d+.\d+.\d+/, 122 | labels: { 123 | external: [{ match: 'Feature', name: 'Features' }, { match: 'Bug', name: 'Bugs' }], 124 | local: [{ match: /Hotfix [-~]? ?/, name: 'Others' }] 125 | }, 126 | verbosity: 3, 127 | render: { 128 | all: render.all, 129 | commit: render.commit, 130 | group: render.group, 131 | version: render.version, 132 | combine: render.combine 133 | } 134 | }; 135 | const configuration = _.merge({}, 136 | defaults, 137 | readConfiguration(commander.config), 138 | _.pick(commander, ['dir', 'upstream', 'token', 'rotate', 'tag', 'tagRegex', 'verbosity', 'type']) 139 | ); 140 | 141 | const { valid, error } = validator.validate(configuration); 142 | if (!valid) { 143 | console.error(error); 144 | process.exit(1); 145 | } 146 | 147 | const { dir, upstream, labels, ...rest } = configuration; 148 | 149 | // Ensure valid git directory. 150 | const inputDirectory = path.resolve(dir); 151 | // The directory must exist and be valid git repo, otherwise we can't read it. 152 | if (!fs.existsSync(inputDirectory) || !fs.existsSync(`${inputDirectory}/.git`)) { 153 | console.error(`${inputDirectory} does not exist, or is not a valid git repo.`); 154 | process.exit(1); 155 | } 156 | 157 | // Ensure valid GitHub repo. 158 | const parseGitHub = (upstream = '') => { 159 | const splitted = upstream.split('/'); 160 | if (splitted.length !== 2) { 161 | console.error(`${upstream} invalid GitHub repo.`); 162 | process.exit(1); 163 | } 164 | return { owner: splitted[0], repo: splitted[1] }; 165 | }; 166 | 167 | // eslint-disable-next-line new-cap 168 | const logger = Logger({ level: configuration.verbosity }); 169 | 170 | return { 171 | logger, 172 | ...parseGitHub(upstream), 173 | dir: inputDirectory, 174 | externalLabels: labels.external, 175 | localLabels: labels.local, 176 | ...rest 177 | }; 178 | } 179 | 180 | main(parseCmd(process.argv)) 181 | .catch((e) => { 182 | if (e.code && e.code === '504') { 183 | console.error(`Failed connecting to GitHub: ${e.message}`); 184 | } else { 185 | console.error(e.message); 186 | } 187 | console.error(e); 188 | process.exit(1); 189 | }); 190 | -------------------------------------------------------------------------------- /lib/git.js: -------------------------------------------------------------------------------- 1 | const execShell = require('execa').shell; 2 | const _ = require('lodash'); 3 | const Octokit = require('@octokit/rest'); 4 | 5 | const delay = (ms) => new Promise((resolve) => setTimeout(resolve, ms)); 6 | 7 | /** 8 | * Get local commits from git. 9 | * @param {string} cwd the directory to read from. 10 | * @param {string} from the tag to start from. 11 | * @param {string} to the tag to read to. 12 | * @returns {Promise} 13 | */ 14 | async function getCommitsFromGit({ cwd, from, to }) { 15 | const { stdout } = await execShell(`git log --pretty=format:"%h %aI %s" ${from}...${to}`, { cwd }); 16 | return stdout; 17 | } 18 | 19 | /** 20 | * Get local tags from git. 21 | * @param {string} cwd the directory to read from. 22 | * @param {number} count the number of tags to get. 23 | * @returns {Promise} 24 | */ 25 | async function getLatestTagsFromGit({ cwd, count }) { 26 | const { stdout } = await execShell(`git log --tags --simplify-by-decoration --pretty="format:%aI %D" | grep tag: | sort -r | head -${count}`, { cwd }); 27 | return stdout; 28 | } 29 | 30 | /** 31 | * Get an issue from GitHub. 32 | * @param {Object} github GitHub API instance. 33 | * @param {string} owner Name of owner. 34 | * @param {string} repo Name of repo. 35 | * @param {number} number Number of the issue. 36 | * @returns {Promise