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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(changelog): updating changelog script to separate by folder #4441

Merged
merged 3 commits into from
Nov 11, 2020
Merged

chore(changelog): updating changelog script to separate by folder #4441

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
138e951
chore(changelog): updating changelog script to separate by folder
jeffchew Nov 10, 2020
54888ab
Merge branch 'master' into chore/release-notes
jeffchew Nov 10, 2020
e0c41d8
Merge branch 'master' into chore/release-notes
kodiakhq[bot] Nov 11, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 38 additions & 14 deletions tasks/get-changelog.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,14 @@ const args = program.parse(process.argv);
*
* @type {string}
*/
const tagFrom = args.tagFrom;
const { tagFrom } = args;

/**
* Tag To (-t)
*
* @type {string}
*/
const tagTo = args.tagTo;
const { tagTo } = args;

/**
* Uses a delimiter for splitting the comments into an array
Expand All @@ -47,14 +47,17 @@ const delimiter = '----DELIMITER----';
/**
* Returns back the commits in an array
*
* @param {string} folder Folder to get commit log for
* @returns {string[]} Commits array of objects
*/
function getCommits() {
function getCommits(folder) {
const toTag = tagTo !== undefined ? tagTo : 'HEAD';

// Gets the git output between the two tags
const output = child
.execSync(`git log ${tagFrom}..${toTag} --pretty=format:"%s"${delimiter}`)
.execSync(
`git log ${tagFrom}..${toTag} --pretty=format:"%s"${delimiter} -- ${folder}`
)
.toString('utf-8');

// Generates the array of commit comments
Expand All @@ -64,42 +67,48 @@ function getCommits() {
/**
* Gets the changelog content
*
* @returns {*} Changelog content
* @param {string} pkgName Package name
* @param {string} folder Folder for git log
* @returns {string} Changelog content
*/
function getChangelog() {
function getChangelog(pkgName, folder) {
// Stores the changelog
let changelog = '';
let changelog = `## ${pkgName}\n`;

// Stores the list of features
const features = [];

// Stores the list of fixes
const fixes = [];

const commitsArray = getCommits();
const commitsArray = getCommits(folder);

commitsArray.forEach(commit => {
commit = commit.replace(delimiter, '');
const commitParse = commit.replace(delimiter, '');
if (commit.startsWith('feat(')) {
let pushFeat = commit.replace('feat(', '- **').replace('):', '**: ');
const pushFeat = commitParse
.replace('feat(', '- **')
.replace('):', '**: ');
features.push(`${pushFeat}\n`);
}
if (commit.startsWith('fix(')) {
let pushFeat = commit.replace('fix(', '- **').replace('):', '**: ');
const pushFeat = commitParse
.replace('fix(', '- **')
.replace('):', '**: ');
fixes.push(`${pushFeat}\n`);
}
});

if (features.length) {
changelog += `## Features\n`;
changelog += `### Features\n`;
features.forEach(feature => {
changelog += feature;
});
changelog += '\n';
}

if (fixes.length) {
changelog += `## Fixes\n`;
changelog += `### Fixes\n`;
fixes.forEach(fix => {
changelog += fix;
});
Expand All @@ -109,4 +118,19 @@ function getChangelog() {
return changelog;
}

console.log(getChangelog());
/**
* Renders the log
*/
function generateLog() {
let log = '';

log += getChangelog('Web Components', './packages/web-components');
log += getChangelog('React', './packages/react');
log += getChangelog('Styles', './packages/styles');
log += getChangelog('Services', './packages/services');
log += getChangelog('Utilities', './packages/utilities');

console.log(log);
}

generateLog();