Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: improve changelog #5777

Merged
merged 1 commit into from
May 21, 2019
Merged

chore: improve changelog #5777

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
46 changes: 23 additions & 23 deletions scripts/changelog.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,13 @@ import uniq from 'lodash/uniq'
import { writeFile } from 'fs-extra'

const types = {
fix: { title: 'Fixes' },
feat: { title: 'Features' },
hotfix: { title: 'HotFixes' },
refactor: { title: 'Refactors' },
perf: { title: 'Performance Improvements' },
examples: { title: 'Examples' },
chore: { title: 'Chore' },
test: { title: 'Tests' }
fix: { title: '馃悰 Bug Fix' },
feat: { title: '馃殌 Features' },
refactor: { title: '馃拝 Refactors' },
perf: { title: '馃敟 Performance' },
examples: { title: '馃摑 Examples' },
chore: { title: '馃彙 Chore' },
test: { title: '馃憮 Tests' }
}

const knownAuthors = [
Expand Down Expand Up @@ -88,6 +87,7 @@ function parseCommits(commits) {
message = message.join(':')

// Extract references from message
message = message.replace(/\((fixes) #\d+\)/g, '')
const references = []
const referencesRegex = /#[0-9]+/g
let m
Expand All @@ -103,6 +103,9 @@ function parseCommits(commits) {
if (scope) {
scope = scope[1]
}
if (!scope) {
scope = 'general'
}
type = type.split('(')[0]

return {
Expand All @@ -116,38 +119,35 @@ function parseCommits(commits) {
}

function generateMarkDown(commits) {
const commitGroups = groupBy(commits, 'type')
const typeGroups = groupBy(commits, 'type')

let markdown = ''

for (const type of allowedTypes) {
const group = commitGroups[type]
const group = typeGroups[type]
if (!group || !group.length) {
continue
}

const { title } = types[type]
markdown += '\n\n' + '## ' + title + '\n\n'
markdown += sortBy(group, 'scope').map(formatCommitForMarkdown).join('\n')
markdown += '\n\n' + '#### ' + title + '\n\n'

const scopeGroups = groupBy(group, 'scope')
for (const scopeName in scopeGroups) {
markdown += '- `' + scopeName + '`' + '\n'
for (const commit of scopeGroups[scopeName]) {
markdown += ' - ' + commit.references.join(',') + ' ' + commit.message + '\n'
}
}
}

const authors = sortBy(uniq(commits.map(commit => commit.authorName).filter(an => !isKnownAuthor(an))))
if (authors.length) {
markdown += '\n\n' + '## ' + 'Thanks to' + '\n\n'
markdown += '\n\n' + '#### ' + '馃挅 Thanks to' + '\n\n'
markdown += authors.map(name => '- ' + name).join('\n')
}

return markdown.trim()
}

function formatCommitForMarkdown({ scope, type, message, references }) {
let fMessage = scope ? `**${scope}**: ${message}` : message

if (references.length) {
fMessage += ' ' + references.map(r => `(${r})`).join(' ')
}

return '- ' + fMessage
}

main().catch(consola.error)