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

Jump to bottom

Add support for auto-generating multiple RCs for the current version if a previous RC exists #25971

Merged
merged 13 commits into from
Oct 20, 2020
Merged

Add support for auto-generating multiple RCs for the current version if a previous RC exists #25971

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
26c1e43
Add support for auto-generating multiple RCs or the current version i…
fullofcaffeine Oct 9, 2020
2f86bd0
Use semver to detect if its prerelease and to incremenet RCs
fullofcaffeine Oct 12, 2020
532cdef
Update the description for the release-plugin-rc command to match the…
fullofcaffeine Oct 13, 2020
77f1a44
Simplify the command description
fullofcaffeine Oct 13, 2020
51e8041
Avoid semver-parsing the version multiple times and parse just before…
fullofcaffeine Oct 13, 2020
8b984b6
Whitespace
ockham Oct 13, 2020
366a748
Force-push to the release branch to avoid ref errors in sub-sequent R…
fullofcaffeine Oct 14, 2020
8e411cc
Simplify jsdoc type
fullofcaffeine Oct 14, 2020
995b449
Change options argument passed over to simple-git push to an object
fullofcaffeine Oct 14, 2020
98d4789
Re-arrange version arithmetics
ockham Oct 14, 2020
b4ccbc7
Add back exports :rolleyes:
ockham Oct 14, 2020
069f5f8
Re-arrange the version versioning logic a bit
fullofcaffeine Oct 15, 2020
fe8dd47
Remove redundant version return and DRY things a bit more
fullofcaffeine Oct 15, 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
4 changes: 1 addition & 3 deletions bin/plugin/cli.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,7 @@ const { runPerformanceTests } = require( './commands/performance' );
program
.command( 'release-plugin-rc' )
.alias( 'rc' )
.description(
'Release an RC version of the plugin (supports only rc.1 for now)'
)
.description( 'Release an RC version of the plugin' )
.action( catchException( releaseRC ) );

program
Expand Down
138 changes: 68 additions & 70 deletions bin/plugin/commands/release.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,32 +58,20 @@ async function runSvnRepositoryCheckoutStep( abortMessage ) {

/**
* Creates a new release branch based on the last package.json version
* and chooses the next RC version number.
* and chooses the next version number.
*
* @param {string} gitWorkingDirectoryPath Git Working Directory Path.
* @param {string} abortMessage Abort Message.
*
* @return {Promise<Object>} chosen version and versionLabels.
* @param {string} version the new version.
* @param {string} releaseBranch The release branch to push to.
*/
async function runReleaseBranchCreationStep(
gitWorkingDirectoryPath,
abortMessage
abortMessage,
version,
releaseBranch
) {
let version, releaseBranch, versionLabel;
await runStep( 'Creating the release branch', abortMessage, async () => {
const packageJsonPath = gitWorkingDirectoryPath + '/package.json';
const packageJson = readJSONFile( packageJsonPath );
const nextMajor = getNextMajorVersion( packageJson.version );
const parsedMajorVersion = semver.parse( nextMajor );

version = nextMajor + '-rc.1';
releaseBranch =
'release/' +
parsedMajorVersion.major +
'.' +
parsedMajorVersion.minor;
versionLabel = nextMajor + ' RC1';

await askForConfirmation(
'The Plugin version to be used is ' +
formats.success( version ) +
Expand All @@ -92,75 +80,46 @@ async function runReleaseBranchCreationStep(
abortMessage
);

// Creating the release branch
// Creates the release branch
await git.createLocalBranch( gitWorkingDirectoryPath, releaseBranch );

log(
'>> The local release branch ' +
formats.success( releaseBranch ) +
' has been successfully created.'
);
} );

return {
version,
versionLabel,
releaseBranch,
};
}

/**
* Checkouts out the release branch and chooses a stable version number.
* Checkouts out the release branch.
*
* @param {string} gitWorkingDirectoryPath Git Working Directory Path.
* @param {string} abortMessage Abort Message.
*
* @return {Promise<Object>} chosen version and versionLabels.
* @param {string} version The new version.
* @param {string} releaseBranch The release branch to checkout.
*/
async function runReleaseBranchCheckoutStep(
gitWorkingDirectoryPath,
abortMessage
abortMessage,
version,
releaseBranch
) {
let releaseBranch, version;
await runStep(
'Getting into the release branch',
abortMessage,
async () => {
const packageJsonPath = gitWorkingDirectoryPath + '/package.json';
releaseBranch = findReleaseBranchName( packageJsonPath );
await git.checkoutRemoteBranch(
gitWorkingDirectoryPath,
releaseBranch
);

log(
'>> The local release branch ' +
formats.success( releaseBranch ) +
' has been successfully checked out.'
);

const releaseBranchPackageJson = readJSONFile( packageJsonPath );
const releaseBranchParsedVersion = semver.parse(
releaseBranchPackageJson.version
);

if (
releaseBranchParsedVersion.prerelease &&
releaseBranchParsedVersion.prerelease.length
) {
version =
releaseBranchParsedVersion.major +
'.' +
releaseBranchParsedVersion.minor +
'.' +
releaseBranchParsedVersion.patch;
} else {
version =
releaseBranchParsedVersion.major +
'.' +
releaseBranchParsedVersion.minor +
'.' +
( releaseBranchParsedVersion.patch + 1 );
}

await askForConfirmation(
'The Version to release is ' +
formats.success( version ) +
Expand All @@ -170,12 +129,6 @@ async function runReleaseBranchCheckoutStep(
);
}
);

return {
version,
versionLabel: version,
releaseBranch,
};
}

/**
Expand Down Expand Up @@ -371,10 +324,12 @@ async function runPushGitChangesStep(
true,
abortMessage
);

await git.pushBranchToOrigin(
gitWorkingDirectoryPath,
releaseBranch
);

await git.pushTagsToOrigin( gitWorkingDirectoryPath );
}
);
Expand Down Expand Up @@ -684,6 +639,8 @@ async function isMilestoneClear( version ) {
async function releasePlugin( isRC = true ) {
// This is a variable that contains the abort message shown when the script is aborted.
let abortMessage = 'Aborting!';
let version, releaseBranch;

const temporaryFolders = [];

await askForConfirmation( 'Ready to go? ' );
Expand All @@ -700,16 +657,57 @@ async function releasePlugin( isRC = true ) {
const gitWorkingDirectory = await runGitRepositoryCloneStep( abortMessage );
temporaryFolders.push( gitWorkingDirectory );

// Creating the release branch
const { version, versionLabel, releaseBranch } = isRC
? await runReleaseBranchCreationStep(
const packageJsonPath = gitWorkingDirectory + '/package.json';
const packageJson = readJSONFile( packageJsonPath );
const packageVersion = packageJson.version;
const parsedPackagedVersion = semver.parse( packageJson.version );
const isPackageVersionRC = parsedPackagedVersion.prerelease.length > 0;

// Are we going to release an RC?
if ( isRC ) {
// We are releasing an RC.
// If packageVersion is stable, then generate new branch and RC1.
// If packageVersion is RC, then checkout branch and inc RC.
if ( ! isPackageVersionRC ) {
version = getNextMajorVersion( packageVersion ) + '-rc.1';
const parsedVersion = semver.parse( version );

releaseBranch =
'release/' + parsedVersion.major + '.' + parsedVersion.minor;

await runReleaseBranchCreationStep(
gitWorkingDirectory,
abortMessage
)
: await runReleaseBranchCheckoutStep(
abortMessage,
version,
releaseBranch
);
} else {
version = semver.inc( packageVersion, 'prerelease', 'rc' );
releaseBranch = findReleaseBranchName( packageJsonPath );

await runReleaseBranchCheckoutStep(
gitWorkingDirectory,
abortMessage
);
abortMessage,
version,
releaseBranch
);
}
} else {
// We are releasing a stable version.
// If packageVersion is stable, then checkout the branch and inc patch.
// If packageVersion is RC, then checkout the branch and inc patch, effectively removing the RC.
version = semver.inc( packageVersion, 'patch' );
releaseBranch = findReleaseBranchName( packageJsonPath );

await runReleaseBranchCheckoutStep(
gitWorkingDirectory,
abortMessage,
version,
findReleaseBranchName( packageJsonPath )
);
}

const versionLabel = version.replace( /\-rc\.([0-9]+)/, ' RC$1' );

if ( ! ( await isMilestoneClear( version ) ) ) {
await askForConfirmation(
Expand Down