-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Auto-merge for PR #33 via VersionBot
Add versionist config
- Loading branch information
Showing
2 changed files
with
74 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
'use strict'; | ||
|
||
const execSync = require('child_process').execSync; | ||
|
||
const getAuthor = (commitHash) => { | ||
return execSync(`git show --quiet --format="%an" ${commitHash}`, { | ||
encoding: 'utf8' | ||
}).replace('\n', ''); | ||
}; | ||
|
||
module.exports = { | ||
// This setup allows the editing and parsing of footer tags to get version and type information, | ||
// as well as ensuring tags of the type 'v<major>.<minor>.<patch>' are used. | ||
// It increments in a semver compatible fashion. | ||
editChangelog: true, | ||
parseFooterTags: true, | ||
getGitReferenceFromVersion: 'v-prefix', | ||
incrementVersion: 'semver', | ||
editVersion: false, | ||
|
||
// Always add the entry to the top of the Changelog, below the header. | ||
addEntryToChangelog: { | ||
preset: 'prepend', | ||
fromLine: 6 | ||
}, | ||
|
||
// Only include a commit when there is a footer tag of 'change-type'. | ||
// Ensures commits which do not up versions are not included. | ||
includeCommitWhen: (commit) => { | ||
return !!commit.footer['change-type']; | ||
}, | ||
|
||
// Determine the type from 'change-type:' tag. | ||
// Should no explicit change type be made, then no changes are assumed. | ||
getIncrementLevelFromCommit: (commit) => { | ||
if (commit.footer['change-type']) { | ||
return commit.footer['change-type'].trim(); | ||
} | ||
}, | ||
|
||
// If a 'changelog-entry' tag is found, use this as the subject rather than the | ||
// first line of the commit. | ||
transformTemplateData: (data) => { | ||
data.commits.forEach((commit) => { | ||
commit.subject = commit.footer['changelog-entry'] || commit.subject; | ||
commit.author = getAuthor(commit.hash); | ||
}); | ||
|
||
return data; | ||
}, | ||
|
||
template: [ | ||
'## v{{version}} - {{moment date "Y-MM-DD"}}', | ||
'', | ||
'{{#each commits}}', | ||
'{{#if this.author}}', | ||
'* {{capitalize this.subject}} [{{this.author}}]', | ||
'{{else}}', | ||
'* {{capitalize this.subject}}', | ||
'{{/if}}', | ||
'{{/each}}' | ||
].join('\n') | ||
}; | ||
|