Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Versionist is a small utility to automatically generate CHANGELOGs based on a certain commit convention. This PR adds a new `changelog` npm script that calls Versionist to preppend a new CHANGELOG entry based on our current structure. Dealing with links to changes between versions in GitHub is hard to automatise with a tool like Versionist. We chose to get rid of such links since they are a nice to have, but don't provide any meaningful value to maintainers, since they can manually see the diffs with `git diff`. Signed-off-by: Juan Cruz Viotti <jviottidc@gmail.com>
- Loading branch information
Showing
4 changed files
with
108 additions
and
35 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
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,92 @@ | ||
| /* | ||
| * Copyright 2016 Resin.io | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| 'use strict'; | ||
|
|
||
| module.exports = { | ||
|
|
||
| subjectParser: 'angular', | ||
|
|
||
| getGitReferenceFromVersion: 'v-prefix', | ||
|
|
||
| editChangelog: true, | ||
|
|
||
| editVersion: false, | ||
|
|
||
| addEntryToChangelog: { | ||
| preset: 'prepend', | ||
| fromLine: 5 | ||
| }, | ||
|
|
||
| includeCommitWhen: (commit) => { | ||
| return commit.footer['Changelog-Entry']; | ||
| }, | ||
|
|
||
| getIncrementLevelFromCommit: (commit) => { | ||
| return commit.footer['Change-Type']; | ||
| }, | ||
|
|
||
| transformTemplateData: (data) => { | ||
| data.features = data.commits.filter((commit) => { | ||
| return commit.subject.type === 'feat'; | ||
| }); | ||
|
|
||
| data.fixes = data.commits.filter((commit) => { | ||
| return commit.subject.type === 'fix'; | ||
| }); | ||
|
|
||
| data.misc = data.commits.filter((commit) => { | ||
| return ![ 'fix', 'feat' ].includes(commit.subject.type); | ||
| }); | ||
|
|
||
| return data; | ||
| }, | ||
|
|
||
| template: [ | ||
| '## v{{version}} - {{moment date "Y-MM-DD"}}', | ||
| '{{#if features.length}}', | ||
| '', | ||
| '### Features', | ||
| '', | ||
| '{{#each features}}', | ||
| '{{#with footer}}', | ||
| '- {{capitalize Changelog-Entry}}', | ||
| '{{/with}}', | ||
| '{{/each}}', | ||
| '{{/if}}', | ||
| '{{#if fixes.length}}', | ||
| '', | ||
| '### Fixes', | ||
| '', | ||
| '{{#each fixes}}', | ||
| '{{#with footer}}', | ||
| '- {{capitalize Changelog-Entry}}', | ||
| '{{/with}}', | ||
| '{{/each}}', | ||
| '{{/if}}', | ||
| '{{#if misc.length}}', | ||
| '', | ||
| '### Misc', | ||
| '', | ||
| '{{#each misc}}', | ||
| '{{#with footer}}', | ||
| '- {{capitalize Changelog-Entry}}', | ||
| '{{/with}}', | ||
| '{{/each}}', | ||
| '{{/if}}' | ||
| ].join('\n') | ||
|
|
||
| }; |