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

GitHub Actions: Create Release Draft when tagging version #27488

Merged
merged 15 commits into from
Jan 11, 2021
Merged

GitHub Actions: Create Release Draft when tagging version #27488

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
0200967
GitHub Actions: Create Release Draft when tagging version
ockham Dec 3, 2020
26ae4e3
Add needs: build
ockham Dec 3, 2020
026fc3e
Whitespace
ockham Dec 3, 2020
003c813
Fix startsWith
ockham Dec 4, 2020
e7fff1a
Use latest Changelog entry to prefill release body
ockham Jan 8, 2021
d0e19ba
Stray -d flag
ockham Jan 8, 2021
7fb9d45
Remove ZIP build and release creation from release script
ockham Jan 8, 2021
c1db85d
body_path need actions/create-release >= v1.1.2
ockham Jan 8, 2021
20b81a9
Skip version header
ockham Jan 8, 2021
90c91d0
Fix release script
ockham Jan 8, 2021
f72bea1
Whitespace
ockham Jan 8, 2021
11c25c7
Publish release after attaching asset
ockham Jan 11, 2021
fa9f47e
Longform curl params
ockham Jan 11, 2021
477874d
Auth
ockham Jan 11, 2021
6bb426b
Update release script copy
ockham Jan 11, 2021
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
55 changes: 54 additions & 1 deletion .github/workflows/build-plugin-zip.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,57 @@ jobs:
uses: actions/upload-artifact@v2
with:
name: gutenberg-plugin
path: ./gutenberg.zip
path: ./gutenberg.zip

create-release:
name: Create Release Draft and Attach Asset
needs: build
runs-on: ubuntu-latest
if: startsWith(github.ref, 'refs/tags/v')
steps:
- name: Set Release Version
id: get_release_version
run: echo ::set-output name=version::$(echo $GITHUB_REF | cut -d / -f 3 | sed s/^v// | sed 's/-rc./ RC/' )

- name: Download Plugin Zip Artifact
uses: actions/download-artifact@v2
with:
name: gutenberg-plugin

- name: Extract Changelog for Release
run: |
unzip gutenberg.zip changelog.txt
CHANGELOG_REGEX="/=\s[0-9]+\.[0-9]+\.[0-9]+(-rc\.[0-9]+)?\s=/"
awk -i inplace "$CHANGELOG_REGEX"'{p++;next} p==2{exit} p>=1' changelog.txt

- name: Create Release Draft
id: create_release
uses: actions/create-release@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
tag_name: ${{ github.ref }}
release_name: ${{ steps.get_release_version.outputs.version }}
draft: true
prerelease: ${{ contains(github.ref, 'rc') }}
body_path: changelog.txt

- name: Upload Release Asset
id: upload-release-asset
uses: actions/upload-release-asset@v1.0.1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
upload_url: ${{ steps.create_release.outputs.upload_url }}
asset_path: ./gutenberg.zip
asset_name: gutenberg.zip
asset_content_type: application/zip

- name: Publish Release
run: |
curl \
--request PATCH \
--url https://api.github.com/repos/${{ github.repository }}/releases/${{ steps.create_release.outputs.id }} \
--header 'Authorization: token ${{ secrets.GITHUB_TOKEN }}' \
--header "Accept: application/vnd.github.v3+json" \
--data-raw '{"draft":false}'
201 changes: 22 additions & 179 deletions bin/plugin/commands/release.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,7 @@ const { sprintf } = require( 'sprintf-js' );
* Internal dependencies
*/
const { log, formats } = require( '../lib/logger' );
const {
askForConfirmation,
runStep,
readJSONFile,
runShellScript,
} = require( '../lib/utils' );
const { askForConfirmation, runStep, readJSONFile } = require( '../lib/utils' );
const git = require( '../lib/git' );
const { getNextMajorVersion } = require( '../lib/version' );
const {
Expand Down Expand Up @@ -219,35 +214,6 @@ async function runBumpPluginVersionUpdateChangelogAndCommitStep(
return commitHash;
}

/**
* Run the Plugin ZIP Creation step.
*
* @param {string} gitWorkingDirectoryPath Git Working Directory Path.
* @param {string} abortMessage Abort message.
*
* @return {Promise<string>} Plugin ZIP Path
*/
async function runPluginZIPCreationStep(
gitWorkingDirectoryPath,
abortMessage
) {
const zipPath = gitWorkingDirectoryPath + '/' + config.slug + '.zip';
await runStep( 'Plugin ZIP creation', abortMessage, async () => {
await askForConfirmation(
'Proceed and build the plugin ZIP? (It takes a few minutes)',
true,
abortMessage
);
runShellScript( config.buildZipCommand, gitWorkingDirectoryPath );
log(
'>> The plugin ZIP has been built successfully. Path: ' +
formats.success( zipPath )
);
} );

return zipPath;
}

/**
* Create a local Git Tag.
*
Expand Down Expand Up @@ -345,112 +311,6 @@ async function runCherrypickBumpCommitIntoMasterStep(
);
}

/**
* Creates the github release and uploads the ZIP file into it.
*
* @param {string} zipPath Plugin zip path.
* @param {string} version Released version.
* @param {string} versionLabel Label of the released Version.
* @param {string} changelog Release changelog.
* @param {boolean} isPrerelease is a pre-release.
* @param {string} abortMessage Abort message.
*
* @return {Promise<Object>} Github release object.
*/
async function runGithubReleaseStep(
zipPath,
version,
versionLabel,
changelog,
isPrerelease,
abortMessage
) {
let octokit;
let releaseDraft;
let release;

await runStep(
'Creating the GitHub release draft',
abortMessage,
async () => {
await askForConfirmation(
'Proceed with the creation of the GitHub release draft?',
true,
abortMessage
);

const { token } = await inquirer.prompt( [
{
type: 'input',
name: 'token',
message:
'Please enter a GitHub personal authentication token.\n' +
'You can create one by navigating to ' +
formats.success(
'https://github.com/settings/tokens/new?scopes=repo,admin:org,write:packages'
) +
'.\nToken:',
},
] );

octokit = new Octokit( {
auth: token,
} );

const releaseDraftData = await octokit.repos.createRelease( {
owner: config.githubRepositoryOwner,
repo: config.githubRepositoryName,
tag_name: 'v' + version,
name: versionLabel,
body: changelog,
prerelease: isPrerelease,
draft: true,
} );
releaseDraft = releaseDraftData.data;

log( '>> The GitHub release draft has been created.' );
}
);
abortMessage =
abortMessage +
' Make sure to remove the the GitHub release draft as well.';

// Uploading the Zip to the Github release
await runStep( 'Uploading the plugin ZIP', abortMessage, async () => {
const filestats = fs.statSync( zipPath );
await octokit.repos.uploadReleaseAsset( {
url: releaseDraft.upload_url,
headers: {
'content-length': filestats.size,
'content-type': 'application/zip',
},
name: config.slug + '.zip',
file: fs.createReadStream( zipPath ),
} );
log( '>> The plugin ZIP has been successfully uploaded.' );
} );

// Remove draft status from the Github release
await runStep( 'Publishing the Github release', abortMessage, async () => {
const releaseData = await octokit.repos.updateRelease( {
owner: config.githubRepositoryOwner,
repo: config.githubRepositoryName,
release_id: releaseDraft.id,
draft: false,
} );
release = releaseData.data;

log( '>> The GitHub release has been published.' );
} );

log(
'>> The GitHub release is available here: ' +
formats.success( release.html_url )
);

return release;
}

/**
* Checks whether the milestone associated with the release has open issues or
* pull requests. Returns a promise resolving to true if there are no open issue
Expand Down Expand Up @@ -500,7 +360,7 @@ async function isMilestoneClear( version ) {
*
* @param {boolean} isRC Whether it's an RC release or not.
*
* @return {Promise<Object>} Github release object.
* @return {string} The new version.
*/
async function releasePlugin( isRC = true ) {
// This is a variable that contains the abort message shown when the script is aborted.
Expand Down Expand Up @@ -573,8 +433,6 @@ async function releasePlugin( isRC = true ) {
);
}

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

if ( ! ( await isMilestoneClear( version ) ) ) {
await askForConfirmation(
'There are still open issues in the milestone. Are you sure you want to proceed?',
Expand All @@ -591,12 +449,6 @@ async function releasePlugin( isRC = true ) {
abortMessage
);

// Plugin ZIP creation
const zipPath = await runPluginZIPCreationStep(
gitWorkingDirectory,
abortMessage
);

// Creating the git tag
await runCreateGitTagStep( gitWorkingDirectory, version, abortMessage );

Expand All @@ -607,21 +459,6 @@ async function releasePlugin( isRC = true ) {
abortMessage
);

abortMessage =
'Aborting! Make sure to ' +
( isRC ? 'remove' : 'reset' ) +
' the remote release branch and remove the git tag.';

// Creating the GitHub Release
const release = await runGithubReleaseStep(
zipPath,
version,
versionLabel,
changelog,
isRC,
abortMessage
);

abortMessage =
'Aborting! Make sure to manually cherry-pick the ' +
formats.success( commitHash ) +
Expand All @@ -637,29 +474,32 @@ async function releasePlugin( isRC = true ) {
abortMessage = 'Aborting! The release is finished though.';
await runCleanLocalFoldersStep( temporaryFolders, abortMessage );

return release;
return version;
}

async function releaseRC() {
log(
formats.title( '\n💃 Time to release ' + config.name + ' 🕺\n\n' ),
'Welcome! This tool is going to help you release a new RC version of the Plugin.\n',
'It goes through different steps: creating the release branch, bumping the plugin version, tagging and creating the GitHub release, building the ZIP...\n',
'It goes through different steps: creating the release branch, bumping the plugin version, tagging the release, and pushing the tag to GitHub.\n',
'Once the tag is pushed to GitHub, GitHub will build the plugin ZIP, attach it to a release, and publish it.\n',
"To perform a release you'll have to be a member of the " +
config.team +
' Team.\n'
);

const release = await releasePlugin( true );
const version = await releasePlugin( true );

log(
'\n>> 🎉 The ' +
config.name +
' version ' +
formats.success( release.name ) +
' has been successfully released.\n',
'You can access the GitHub release here: ' +
formats.success( release.html_url ) +
formats.success( version ) +
' has been successfully tagged.\n',
"In a few minutes, you'll be able to find the GitHub release here: " +
formats.success(
`${ config.wpRepositoryReleasesURL }v${ version }`
) +
'\n',
'Thanks for performing the release!\n'
);
Expand All @@ -669,24 +509,27 @@ async function releaseStable() {
log(
formats.title( '\n💃 Time to release ' + config.name + ' 🕺\n\n' ),
'Welcome! This tool is going to help you release a new stable version of the Plugin.\n',
'It goes through different steps: bumping the plugin version, tagging and creating the GitHub release, building the ZIP, pushing the release to the SVN repository...\n',
'It goes through different steps: bumping the plugin version, tagging the release, and pushing the tag to GitHub.\n',
'Once the tag is pushed to GitHub, GitHub will build the plugin ZIP, attach it to a release, publish it, and push the release to the SVN repository.\n',
"To perform a release you'll have to be a member of the " +
config.team +
' Team.\n'
);

const release = await releasePlugin( false );
const version = await releasePlugin( false );

log(
'\n>> 🎉 ' +
config.name +
' ' +
formats.success( release.name ) +
' has been successfully released.\n',
'You can access the GitHub release here: ' +
formats.success( release.html_url ) +
formats.success( version ) +
' has been successfully tagged.\n',
"In a few minutes, you'll be able to find the GitHub release here: " +
formats.success(
`${ config.wpRepositoryReleasesURL }v${ version }`
) +
'\n',
"In a few minutes, you'll be able to update the plugin from the WordPress repository.\n",
"Once published, it'll be automatically uploaded to the WordPress plugin repository.\n",
"Thanks for performing the release! and don't forget to publish the release post.\n"
);
}
Expand Down