Skip to content

Commit

Permalink
Merge pull request #656 from ckeditor/i/7323
Browse files Browse the repository at this point in the history 
Other (env): The changelog generator for mono repository will use the same version for all packages. On the screen, a user will see all changes: `MAJOR BREAKING CHANGES`, `MINOR BREAKING CHANGES`, and all commits since the last release. The user must review it and provide the version. Closes ckeditor/ckeditor5#7323.

MAJOR BREAKING CHANGES (env): Task `generateChangelogForMonoRepository()` will generate the changelog uses the same version for all packages.
  • Loading branch information
@mlewand
mlewand authored Jul 8, 2020
2 parents a92e686 + 36a799f commit 4036b6e
Show file tree
Hide file tree
Showing 4 changed files with 130 additions and 207 deletions.
256 changes: 96 additions & 160 deletions packages/ckeditor5-dev-env/lib/release-tools/tasks/generatechangelogformonorepository.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ const displayCommits = require( '../utils/displaycommits' );
const displaySkippedPackages = require( '../utils/displayskippedpackages' );
const generateChangelog = require( '../utils/generatechangelog' );
const getPackageJson = require( '../utils/getpackagejson' );
const getNewVersionType = require( '../utils/getnewversiontype' );
const getPackagesPaths = require( '../utils/getpackagespaths' );
const getCommits = require( '../utils/getcommits' );
const getNewVersionType = require( '../utils/getnewversiontype' );
const getWriterOptions = require( '../utils/getwriteroptions' );
const { getRepositoryUrl } = require( '../utils/transformcommitutils' );
const transformCommitFactory = require( '../utils/transformcommitfactory' );
Expand All @@ -32,6 +32,8 @@ const noteInfo = `[ℹ️](${ VERSIONING_POLICY_URL }#major-and-minor-breaking-c
* Generates the single changelog for the mono repository. It means that changes which have been done in all packages
* will be described in the changelog file located in the `options.cwd` directory.
*
* The typed version will be the same for all packages. See: https://github.com/ckeditor/ckeditor5/issues/7323.
*
* @param {Object} options
*
* @param {String} options.cwd Current working directory (packages) from which all paths will be resolved.
Expand Down Expand Up @@ -81,17 +83,9 @@ module.exports = function generateChangelogForMonoRepository( options ) {
// Collection of public entries that will be inserted in the changelog.
let publicCommits;

// Whether the next release will be bumped as "major" release.
// It depends on commits. If there is any of them that contains a "MAJOR BREAKING CHANGES" note,
// all packages must be released as a major change.
let willBeMajorBump = false;

// If the next release will be the major bump, this variable will contain next version for all packages.
// The next version for the upcoming release.
let nextVersion = null;

// Packages which during typing the new versions, the user proposed "skip" version.
const skippedChangelogs = new Set();

// A map contains packages and their new versions.
const packagesVersion = new Map();

Expand All @@ -111,18 +105,14 @@ module.exports = function generateChangelogForMonoRepository( options ) {

logInfo( `Found ${ commits.length } entries to parse.`, { indentLevel: 1 } );
} )
.then( () => confirmMajorVersionBump() )
.then( () => typeNewProposalVersionForAllPackages() )
.then( () => confirmVersionForPackages() )
.then( () => findPackagesWithInternalBumps() )
.then( () => typeNewVersionForAllPackages() )
.then( () => generateChangelogFromCommits() )
.then( changesFromCommits => saveChangelog( changesFromCommits ) )
.then( () => {
logProcess( 'Summary' );

displaySkippedPackages( new Set( [
...pathsCollection.skipped,
...skippedChangelogs
...pathsCollection.skipped
].sort() ) );

// Make a commit from the repository where we started.
Expand All @@ -142,65 +132,16 @@ module.exports = function generateChangelogForMonoRepository( options ) {
} );

/**
* Asks the user whether found "MAJOR BREAKING CHANGES" commits are true.
* Asks the user about the new version for all packages for the upcoming release.
*
* @returns {Promise}
*/
function confirmMajorVersionBump() {
logProcess( 'Looking for "MAJOR BREAKING CHANGES" commits...' );

const majorBreakingChangesCommits = filterCommitsByNoteTitle( allCommits, 'MAJOR BREAKING CHANGES' );
const hasMajorBreakingChanges = majorBreakingChangesCommits.length > 0;

if ( hasMajorBreakingChanges ) {
logInfo( `Found ${ chalk.bold( 'MAJOR BREAKING CHANGES' ) }:`, { indentLevel: 1 } );
displayCommits( majorBreakingChangesCommits, { attachLinkToCommit: true, indentLevel: 2 } );
} else {
logInfo( chalk.italic(
'No "MAJOR BREAKING CHANGES" commits found but you can decide whether a next release should be treated as a major.'
), { indentLevel: 1 } );
}
function typeNewVersionForAllPackages() {
logProcess( 'Determining the new version...' );

return cli.confirmMajorBreakingChangeRelease( hasMajorBreakingChanges, { indentLevel: 1 } )
.then( result => {
willBeMajorBump = result;
} );
}

/**
* Finds commits that contain a note which matches to `titleNote`.
*
* @returns {Array.<Commit>}
*/
function filterCommitsByNoteTitle( commits, titleNote ) {
return commits.filter( commit => {
if ( !commit.isPublicCommit ) {
return false;
}

for ( const note of commit.notes ) {
if ( note.title.startsWith( titleNote ) ) {
return true;
}
}

return false;
} );
}

/**
* If the next release will be the major release, the user needs to provide the version which will be used
* as the proposal version for all packages.
*
* @returns {Promise}
*/
function typeNewProposalVersionForAllPackages() {
if ( !willBeMajorBump ) {
return Promise.resolve();
}

logProcess( 'Looking for the highest version in all packages...' );
displayAllChanges();

// Find the highest version in all packages.
const [ packageHighestVersion, highestVersion ] = [ ...pathsCollection.matched ]
.reduce( ( currentHighest, repositoryPath ) => {
const packageJson = getPackageJson( repositoryPath );
Expand All @@ -214,61 +155,84 @@ module.exports = function generateChangelogForMonoRepository( options ) {
return currentHighest;
}, [ null, '0.0.0' ] );

return cli.provideNewMajorReleaseVersion( highestVersion, packageHighestVersion, { indentLevel: 1 } )
let bumpType = getNewVersionType( allCommits );

// When made commits are not public, bump the `patch` version.
if ( bumpType === 'internal' ) {
bumpType = 'patch';
}

return cli.provideNewVersionForMonoRepository( highestVersion, packageHighestVersion, bumpType, { indentLevel: 1 } )
.then( version => {
nextVersion = version;

let promise = Promise.resolve();

// Update the version for all packages.
for ( const packagePath of pathsCollection.matched ) {
promise = promise.then( () => {
const pkgJson = getPackageJson( packagePath );

packagesPaths.set( pkgJson.name, packagePath );
packagesVersion.set( pkgJson.name, nextVersion );
} );
}

return promise;
} );
}

/**
* Asks the user about new versions for all packages.
*
* @returns {Promise}
* Displays breaking changes and commits.
*/
function confirmVersionForPackages() {
logProcess( 'Preparing new version for all packages...' );

const mainPackageName = pkgJson.name;
let promise = Promise.resolve();

for ( const packagePath of pathsCollection.matched ) {
promise = promise.then( () => {
const pkgJson = getPackageJson( packagePath );
function displayAllChanges() {
const majorBreakingChangesCommits = filterCommitsByNoteTitle( allCommits, 'MAJOR BREAKING CHANGES' );
const infoOptions = { indentLevel: 1, startWithNewLine: true };

packagesPaths.set( pkgJson.name, packagePath );
currentPackagesVersion.set( pkgJson.name, pkgJson.version );
if ( majorBreakingChangesCommits.length > 0 ) {
logInfo( `🔸 Found ${ chalk.bold( 'MAJOR BREAKING CHANGES' ) }:`, infoOptions );
displayCommits( majorBreakingChangesCommits, { attachLinkToCommit: true, indentLevel: 2 } );
} else {
logInfo( `🔸 ${ chalk.bold( 'MAJOR BREAKING CHANGES' ) } commits have not been found.`, infoOptions );
}

logInfo( `Processing "${ chalk.underline( pkgJson.name ) }"...`, { indentLevel: 1, startWithNewLine: true } );
const minorBreakingChangesCommits = filterCommitsByNoteTitle( allCommits, 'MINOR BREAKING CHANGES' );

const packageCommits = filterCommitsByPath( allCommits, packagePath );
const releaseTypeOrVersion = willBeMajorBump ? nextVersion : getNewVersionType( packageCommits );
if ( minorBreakingChangesCommits.length > 0 ) {
logInfo( `🔸 Found ${ chalk.bold( 'MINOR BREAKING CHANGES' ) }:`, infoOptions );
displayCommits( minorBreakingChangesCommits, { attachLinkToCommit: true, indentLevel: 2 } );
} else {
logInfo( `🔸 ${ chalk.bold( 'MINOR BREAKING CHANGES' ) } commits have not been found.`, infoOptions );
}

displayCommits( packageCommits, { indentLevel: 2 } );
logInfo( '🔸 Commits since the last release:', infoOptions );

const provideVersionOptions = {
indentLevel: 2,
disableSkipVersion: mainPackageName === pkgJson.name
};
const commits = allCommits.sort( sortFunctionFactory( 'scope' ) );

return cli.provideVersion( pkgJson.version, releaseTypeOrVersion, provideVersionOptions )
.then( version => {
if ( version === 'skip' ) {
skippedChangelogs.add( packagePath );
displayCommits( commits, { indentLevel: 2 } );

return Promise.resolve();
}
logInfo( '💡 Review commits listed above and propose the new version for all packages in the upcoming release.', infoOptions );
}

// If the user provided "internal" as a new version, we treat it as a "patch" bump.
if ( version === 'internal' ) {
version = semver.inc( pkgJson.version, 'patch' );
}
/**
* Finds commits that contain a note which matches to `titleNote`.
*
* @returns {Array.<Commit>}
*/
function filterCommitsByNoteTitle( commits, titleNote ) {
return commits.filter( commit => {
if ( !commit.isPublicCommit ) {
return false;
}

packagesVersion.set( pkgJson.name, version );
} );
} );
}
for ( const note of commit.notes ) {
if ( note.title.startsWith( titleNote ) ) {
return true;
}
}

return promise;
return false;
} );
}

/**
Expand All @@ -294,42 +258,6 @@ module.exports = function generateChangelogForMonoRepository( options ) {
} );
}

/**
* Finds packages that were skipped or didn't have any committed changes.
*
* For such packages we want to bump the "patch" version.
* Unless, there should be a major bump.
*
* @returns {Promise}
*/
function findPackagesWithInternalBumps() {
logProcess( 'Checking whether dependencies of skipped packages have changed...' );

let clearRun = false;

while ( !clearRun ) {
clearRun = true;

for ( const packagePath of skippedChangelogs ) {
const pkgJson = getPackageJson( packagePath );

// Check whether the dependencies of the current processing package will be released.
const willUpdateDependencies = Object.keys( pkgJson.dependencies || {} )
.some( dependencyName => packagesVersion.has( dependencyName ) );

// If so, bump the version for current package and release it too.
// The bump can be specified as `major` or `patch`. It depends whether we had the "MAJOR BREAKING CHANGES" commit.
if ( willUpdateDependencies ) {
const version = willBeMajorBump ? nextVersion : semver.inc( pkgJson.version, 'patch' );

packagesVersion.set( pkgJson.name, version );
skippedChangelogs.delete( packagePath );
clearRun = false;
}
}
}
}

/**
* Generates a list of changes based on the commits in the main repository.
*
Expand All @@ -356,22 +284,8 @@ module.exports = function generateChangelogForMonoRepository( options ) {
hash: hash => hash
} );

const sortFunction = compareFunc( item => {
if ( Array.isArray( item.rawScope ) ) {
// A hack that allows moving all scoped commits from the main repository/package at the beginning of the list.
if ( item.rawScope[ 0 ] === pkgJson.name ) {
return 'a'.repeat( 15 );
}

return item.rawScope[ 0 ];
}

// A hack that allows moving all non-scoped commits or breaking changes notes at the end of the list.
return 'z'.repeat( 15 );
} );

writerOptions.commitsSort = sortFunction;
writerOptions.notesSort = sortFunction;
writerOptions.commitsSort = sortFunctionFactory( 'rawScope' );
writerOptions.notesSort = sortFunctionFactory( 'rawScope' );

publicCommits = [ ...allCommits ]
.filter( commit => commit.isPublicCommit )
Expand Down Expand Up @@ -623,6 +537,28 @@ module.exports = function generateChangelogForMonoRepository( options ) {
return `* [${ packageName }](${ npmUrl }): v${ nextVersion }`;
}

/**
* Returns a function that is being used when sorting commits.
*
* @param {String} scopeField A name of the field that saves the commit's scope.
* @returns {Function}
*/
function sortFunctionFactory( scopeField ) {
return compareFunc( item => {
if ( Array.isArray( item[ scopeField ] ) ) {
// A hack that allows moving all scoped commits from the main repository/package at the beginning of the list.
if ( item[ scopeField ][ 0 ] === pkgJson.name ) {
return 'a'.repeat( 15 );
}

return item[ scopeField ][ 0 ];
}

// A hack that allows moving all non-scoped commits or breaking changes notes at the end of the list.
return 'z'.repeat( 15 );
} );
}

function logProcess( message ) {
log.info( '\n📍 ' + chalk.cyan( message ) );
}
Expand Down
Loading

0 comments on commit 4036b6e

Please sign in to comment.