mirror of
https://github.com/angular/angular.git
synced 2026-09-14 13:54:52 +08:00
build: introduce and document pnpm run devtools:release command (#63599)
This commit introduces a new `pnpm run devtools:release` command to streamline the Angular DevTools release process. The command automates the entire release workflow, including checking for new commits, updating version numbers, creating a release commit, and guiding the user through the publishing steps for both Chrome and Firefox extensions. The `devtools/docs/release.md` documentation has been updated to reflect the use of this new command, providing a single entry point for the release process. A new script `devtools/tools/release.mts` has been added to implement the release logic, and `package.json` has been updated to include the new script. PR Close #63599
This commit is contained in:
Alan Agius
committed by
Jessica Janiuk
Jessica Janiuk
parent
ce4ab17858
commit
1590663e7d
+2
-145
@@ -1,150 +1,7 @@
|
||||
# Publish Angular DevTools
|
||||
|
||||
Publishing Angular DevTools is achieved through the following steps:
|
||||
|
||||
## 0. Check if there's anything to release
|
||||
|
||||
On the `main` branch, run:
|
||||
To publish Angular DevTools, run the following command and follow the prompts:
|
||||
|
||||
```shell
|
||||
git checkout main
|
||||
git pull upstream main
|
||||
git log "HEAD...$(git log HEAD~1 --grep="release:.*Angular DevTools" --format=format:%H | head -n 1)~1" --format=format:%s |
|
||||
grep -E "(fix|feat|perf)\(devtools\):|release:.*Angular DevTools" -i --color=never
|
||||
pnpm run devtools:release
|
||||
```
|
||||
|
||||
If this displays any commits since the most recent release commit, then there's something to publish.
|
||||
If it only shows the most recent release commit, then the DevTools release can be skipped.
|
||||
|
||||
## 1. Update extension version numbers
|
||||
|
||||
Bump the version numbers listed in
|
||||
[`manifest.chrome.json`](/devtools/projects/shell-browser/src/manifest/manifest.chrome.json)
|
||||
and [`manifest.firefox.json`](/devtools/projects/shell-browser/src/manifest/manifest.firefox.json).
|
||||
|
||||
While technically optional, it's recommended to clean up potential artifacts from previous releases:
|
||||
|
||||
```shell
|
||||
rm -f ~/devtools-chrome.zip ~/devtools-firefox.zip ~/angular-source.zip
|
||||
git branch -D devtools-release
|
||||
```
|
||||
|
||||
## 2. Commit and merge
|
||||
|
||||
Commit the version bump:
|
||||
|
||||
```shell
|
||||
git checkout -b devtools-release
|
||||
git add . && git commit -m "release: bump Angular DevTools version to ${VERSION}"
|
||||
git push -u origin devtools-release
|
||||
# Alternatively, if there might be a pre-existing branch from a previous release:
|
||||
git push -u origin devtools-release --force-with-lease
|
||||
```
|
||||
|
||||
Then create and merge a PR targeting `minor` with this change. Merging this PR does not
|
||||
have any automation associated with it and can be merged at any time.
|
||||
|
||||
## 3. Sync to merged commit
|
||||
|
||||
Once the PR is merged, pull and check out that specific commit hash on `main` and install
|
||||
dependencies as they might have changed since your last install.
|
||||
|
||||
```shell
|
||||
git fetch upstream main
|
||||
git checkout "${MERGED_RELEASE_COMMIT}"
|
||||
|
||||
nvm install
|
||||
pnpm install --frozen-lockfile
|
||||
```
|
||||
|
||||
Note that while the steps below can technically be done without merging the release PR
|
||||
or checking out the merged commit, doing so is useful for release stability (actually
|
||||
releasing what the commit history says we are) and is _necessary_ for accurate changelog
|
||||
generation.
|
||||
|
||||
## 4. Publish to Chrome Chrome
|
||||
|
||||
First, make sure you have access to publish the extension by ensuring you are part of
|
||||
[the relevant Google Group](http://g/angular-chrome-web-store-publisher).
|
||||
|
||||
Next, build and package the extension:
|
||||
|
||||
```shell
|
||||
# Build the Chrome version.
|
||||
pnpm devtools:build:chrome:release
|
||||
|
||||
# Package the extension.
|
||||
(cd dist/bin/devtools/projects/shell-browser/src/prodapp && zip -r ~/devtools-chrome.zip *)
|
||||
```
|
||||
|
||||
Then, go to the
|
||||
[Angular DevTools Chrome Web Store page](https://chrome.google.com/webstore/devconsole/19161719-4eee-48dc-959e-8d18cea83699/ienfalfjdbdpebioblfackkekamfmbnh/edit/package)
|
||||
and upload `~/devtools-chrome.zip`.
|
||||
|
||||
You can choose to either publish immediately or only get approval but hold to publish at a later time.
|
||||
Note that even publishing immediately still requires approval from Chrome Web Store before it is
|
||||
available to users. Historically this has been pretty quick (< 30 minutes), but there is no hard upper
|
||||
limit on how long a review might take: https://developer.chrome.com/docs/webstore/review-process#review-time.
|
||||
|
||||
## 5. Publish to Firefox
|
||||
|
||||
To publish Angular DevTools as a Firefox Add-on, first build and package the extension:
|
||||
|
||||
```shell
|
||||
# Build the Firefox version.
|
||||
pnpm devtools:build:firefox:release
|
||||
|
||||
# Package the extension.
|
||||
(cd dist/bin/devtools/projects/shell-browser/src/prodapp && zip -r ~/devtools-firefox.zip *)
|
||||
```
|
||||
|
||||
Then, go to the
|
||||
[Angular DevTools Firefox Addons page](https://addons.mozilla.org/en-US/developers/addon/angular-devtools/edit)
|
||||
and log in using the email and password [from Valentine](http://valentine/#/show/1651707871496288).
|
||||
This will require a two-factor code, which you can generate by installing
|
||||
[Google Authenticator](https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2)
|
||||
and scanning the QR code linked [from Valentine](http://valentine/#/show/1651792043556329).
|
||||
|
||||
Upload `~/devtools-firefox.zip` as a new version. The Firefox publishing process is slightly more
|
||||
involved than Chrome.
|
||||
|
||||
### Source Code
|
||||
|
||||
Mozilla requires extension source code with instructions to build and run it. Since DevTools
|
||||
exists in a monorepo with critical build tooling existing outside the `devtools/` directory, we
|
||||
need to upload the entire monorepo. Package it without dependencies and generated files with the
|
||||
following command and upload it.
|
||||
|
||||
```shell
|
||||
git archive HEAD -o ~/angular-source.zip
|
||||
```
|
||||
|
||||
### Changelog
|
||||
|
||||
Mozilla asks for a changelog, which needs to be authored manually. You can generate the changelog
|
||||
with the following command:
|
||||
|
||||
```shell
|
||||
git log "HEAD~1...$(git log HEAD~1 --grep="release:.*Angular DevTools" --format=format:%H | head -n 1)" --format=format:%s |
|
||||
grep -E "(fix|feat|perf)\(devtools\):|release:.*Angular DevTools" -i --color=never |
|
||||
sed "s,^,* ,g" |
|
||||
sed -E "s,\(#([0-9]+)\),([#\1](https://github.com/angular/angular/pull/\1/)),g"
|
||||
```
|
||||
|
||||
### Reviewer Note
|
||||
|
||||
There is a field to provide a note to the reviewer, copy this template and make sure to replace
|
||||
`${RELEASE_COMMIT}` with the SHA of the release commit to create a valid link.
|
||||
|
||||
> This is a monorepo and includes much more code than just the DevTools extension. The relevant
|
||||
> code is under \`devtools/...\` and \`devtools/README.md\` contains instructions for compiling
|
||||
> release builds locally.
|
||||
>
|
||||
> The uploaded source is equivalent to
|
||||
> https://github.com/angular/angular/tree/${RELEASE_COMMIT}/.
|
||||
|
||||
Similar to Chrome, we need to wait for approval from Mozilla before the extension is released.
|
||||
There's no hard upper-bound on this, but historically it typically takes at least a week.
|
||||
|
||||
Once the new DevTools version is in-review for both Chrome and Firefox, the release process is
|
||||
complete.
|
||||
|
||||
@@ -0,0 +1,482 @@
|
||||
/**
|
||||
* @license
|
||||
* Copyright Google LLC All Rights Reserved.
|
||||
*
|
||||
* Use of this source code is governed by an MIT-style license that can be
|
||||
* found in the LICENSE file at https://angular.dev/license
|
||||
*/
|
||||
|
||||
// tslint:disable:no-console
|
||||
import {input} from '@inquirer/prompts';
|
||||
import chalk from 'chalk';
|
||||
import semver from 'semver';
|
||||
import {writeFile, mkdir, rm, readFile} from 'node:fs/promises';
|
||||
import {exec as nodeExec, spawn, SpawnOptions} from 'node:child_process';
|
||||
import {promisify} from 'node:util';
|
||||
import {join} from 'node:path';
|
||||
|
||||
const exec = promisify(nodeExec);
|
||||
|
||||
/**
|
||||
* Bazel arguments for release builds, ensuring colored output and progress display.
|
||||
*/
|
||||
const additionBazelReleaseArgs = [
|
||||
'--color=yes',
|
||||
'--curses=yes',
|
||||
'--show_progress_rate_limit=5',
|
||||
] as const;
|
||||
|
||||
/** The repository root path */
|
||||
const rootPath = join(import.meta.dirname, '../../');
|
||||
|
||||
/** The remote pointing to the angular/angular repository. */
|
||||
const angularRepoRemote = 'https://github.com/angular/angular.git';
|
||||
|
||||
/**
|
||||
* The prefix for all release commits created by this script.
|
||||
* This is used to filter commits when determining the last release.
|
||||
*/
|
||||
const releaseCommitPrefix = 'release: bump Angular DevTools version to ';
|
||||
|
||||
/**
|
||||
* The path to the manifest files for the Chrome and Firefox extensions.
|
||||
* These files are updated with the new version number at the start of the release process.
|
||||
*/
|
||||
const manifestPaths = [
|
||||
'devtools/projects/shell-browser/src/manifest/manifest.chrome.json',
|
||||
'devtools/projects/shell-browser/src/manifest/manifest.firefox.json',
|
||||
] as const;
|
||||
|
||||
/**
|
||||
* The path to the directory containing the built extension.
|
||||
* This is used to create the zip files for submission to the Chrome and Firefox stores.
|
||||
*/
|
||||
const extensionPath = 'dist/bin/devtools/projects/shell-browser/src/prodapp';
|
||||
|
||||
/**
|
||||
* The URL to the Angular DevTools page on the Chrome Web Store.
|
||||
* This is opened in the browser to allow the user to upload the Chrome extension.
|
||||
*/
|
||||
const chromeWebStoreUrl =
|
||||
'https://chrome.google.com/webstore/devconsole/19161719-4eee-48dc-959e-8d18cea83699/ienfalfjdbdpebioblfackkekamfmbnh/edit/package';
|
||||
|
||||
/**
|
||||
* The URL to the Angular DevTools page on the Firefox Add-ons page.
|
||||
* This is opened in the browser to allow the user to upload the Firefox extension.
|
||||
*/
|
||||
const firefoxAddonsUrl = 'https://addons.mozilla.org/en-US/developers/addon/angular-devtools/edit';
|
||||
|
||||
/**
|
||||
* The URL to the Google Authenticator app on the Google Play Store.
|
||||
* This is displayed to the user to help them set up two-factor authentication for the Firefox
|
||||
* Add-ons page.
|
||||
*/
|
||||
const googleAuthenticatorUrl =
|
||||
'https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2';
|
||||
|
||||
/**
|
||||
* The URL to the Google Group that manages publishing rights for the Chrome extension.
|
||||
* This is displayed to the user if they do not have permission to publish the extension.
|
||||
*/
|
||||
const publisherGoogleGroupUrl = 'http://g/angular-chrome-web-store-publisher';
|
||||
|
||||
/**
|
||||
* The URL to the Valentine page containing the credentials for the Firefox Add-ons page.
|
||||
* This is displayed to the user to help them log in to the Firefox Add-ons page.
|
||||
*/
|
||||
const firefoxCredentialsUrl = 'http://valentine/#/show/1651707871496288';
|
||||
|
||||
/**
|
||||
* The URL to the Valentine page containing the QR code for the Firefox Add-ons page.
|
||||
* This is displayed to the user to help them set up two-factor authentication.
|
||||
*/
|
||||
const firefox2faUrl = 'http://valentine/#/show/1651792043556329';
|
||||
|
||||
/**
|
||||
* The main function for the release script.
|
||||
* This function orchestrates the release process, from checking for new commits to publishing the extension.
|
||||
* It performs the following steps:
|
||||
* 1. Sets the working directory to the root of the repository.
|
||||
* 2. Ensures the working directory is clean.
|
||||
* 3. Fetches the latest changes from the remote.
|
||||
* 4. Checks for new commits since the last release.
|
||||
* 5. Prompts the user for a new version number.
|
||||
* 6. Creates an output directory for the release artifacts.
|
||||
* 7. Updates the manifest files with the new version number.
|
||||
* 8. Prepares the release pull request.
|
||||
* 9. Waits for the user to merge the release PR and get the SHA of the merged commit.
|
||||
* 10. Publishes the Chrome extension.
|
||||
* 11. Publishes the Firefox extension.
|
||||
* 12. Logs a success message.
|
||||
*/
|
||||
async function main(): Promise<void> {
|
||||
process.chdir(rootPath);
|
||||
|
||||
// Ensure the user has a clean working directory before starting the release process.
|
||||
await checkCleanWorkingDirectory();
|
||||
|
||||
// Fetch the latest changes from the remote.
|
||||
console.log(chalk.blue('Fetching latest changes from upstream...'));
|
||||
await exec(`git fetch ${angularRepoRemote} main`);
|
||||
console.log(chalk.green('Successfully fetched latest changes.'));
|
||||
|
||||
// Check if there are any new commits to release.
|
||||
console.log(chalk.blue('Checking for new commits to release...'));
|
||||
const lastReleaseSha = await getLastReleaseSha();
|
||||
const commits = await getCommitsSince(lastReleaseSha);
|
||||
|
||||
if (commits.length === 0) {
|
||||
console.log(chalk.yellow('No new commits to release. Exiting.'));
|
||||
return;
|
||||
}
|
||||
|
||||
console.log(chalk.green('New commits to release:'));
|
||||
for (const commit of commits) {
|
||||
console.log(`- ${commit}`);
|
||||
}
|
||||
|
||||
const newVersion = await getNewVersion(commits);
|
||||
const outputDir = `dist/devtools-release-v${newVersion}`;
|
||||
|
||||
console.log('');
|
||||
console.log(chalk.blue(`Creating output directory: ${outputDir}`));
|
||||
await rm(outputDir, {force: true, recursive: true});
|
||||
await mkdir(outputDir, {recursive: true});
|
||||
console.log(chalk.green(`Created output directory: ${outputDir}`));
|
||||
|
||||
const chromeZipPath = join(outputDir, 'devtools-chrome.zip');
|
||||
const firefoxZipPath = join(outputDir, 'devtools-firefox.zip');
|
||||
const sourceZipPath = join(outputDir, 'angular-source.zip');
|
||||
|
||||
// Update the manifest files with the new version number.
|
||||
await updateManifests(newVersion);
|
||||
|
||||
// Prepare the release pull request.
|
||||
await prepareReleasePullRequest(newVersion);
|
||||
|
||||
// Wait for the user to merge the release PR and get the SHA of the merged commit.
|
||||
const mergedCommitSha = await getMergedCommitSha(newVersion);
|
||||
await checkoutMergedCommitAndInstallDependencies(mergedCommitSha);
|
||||
|
||||
// Publish the Chrome extension.
|
||||
await publishChromeExtension(chromeZipPath);
|
||||
|
||||
// Publish the Firefox extension.
|
||||
await publishFirefoxExtension(mergedCommitSha, firefoxZipPath, sourceZipPath, commits);
|
||||
|
||||
console.log(chalk.green('DevTools release process complete!'));
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks that the working directory is clean.
|
||||
* If the working directory is not clean, the user is prompted to continue or exit.
|
||||
* @throws An error if the user chooses to exit.
|
||||
*/
|
||||
async function checkCleanWorkingDirectory(): Promise<void> {
|
||||
console.log(chalk.blue('Checking for a clean working directory...'));
|
||||
const {stdout: status} = await exec('git status --porcelain');
|
||||
if (status.length > 0) {
|
||||
throw new Error('Your working directory is not clean. There are uncommitted changes.');
|
||||
}
|
||||
console.log(chalk.green('Working directory is clean.'));
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the SHA of the last release commit.
|
||||
* This is used to determine which commits to include in the changelog.
|
||||
* @param version Optional. The version string to search for in the commit message.
|
||||
* @returns A promise that resolves to the SHA of the last release commit.
|
||||
*/
|
||||
async function getLastReleaseSha(version = ''): Promise<string> {
|
||||
const commitMessagePattern = releaseCommitPrefix + version;
|
||||
let {stdout: sha} = await exec(
|
||||
`git log FETCH_HEAD --grep="${commitMessagePattern}" --format=format:%H -n 1`,
|
||||
);
|
||||
|
||||
sha = sha.trim();
|
||||
if (!sha) {
|
||||
throw new Error(`Could not find commit that matches pattern: "${commitMessagePattern}"`);
|
||||
}
|
||||
|
||||
return sha;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the commits since a given SHA.
|
||||
* This is used to determine which commits to include in the changelog.
|
||||
* @param since The SHA of the commit to start from.
|
||||
* @returns A promise that resolves to a list of commit messages since the given SHA.
|
||||
*/
|
||||
async function getCommitsSince(since: string): Promise<string[]> {
|
||||
const {stdout} = await exec(
|
||||
`git log FETCH_HEAD...${since} -E --grep="^(feat|fix|perf)\\(devtools\\):" --format=format:%s`,
|
||||
);
|
||||
|
||||
return stdout
|
||||
.trim()
|
||||
.split('\n')
|
||||
.filter((line) => line.length > 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the new version number from the user.
|
||||
* This function reads the current version from the manifest files, determines the next version based on the commits since the last release, and then prompts the user to confirm the new version.
|
||||
* @param commits A list of commit messages since the last release.
|
||||
* @returns A promise that resolves to the new version number.
|
||||
*/
|
||||
async function getNewVersion(commits: string[]): Promise<string> {
|
||||
console.log('');
|
||||
console.log(chalk.blue('Determining new version...'));
|
||||
const currentVersion = await getCurrentVersion();
|
||||
const releaseType = commits.some((commit) => commit.startsWith('feat')) ? 'minor' : 'patch';
|
||||
const suggestedVersion = semver.inc(currentVersion, releaseType) ?? currentVersion;
|
||||
|
||||
const newVersion = await input({
|
||||
message: 'Enter the new version number',
|
||||
default: suggestedVersion,
|
||||
validate: (value) => {
|
||||
if (!semver.valid(value)) {
|
||||
return chalk.red('Please enter a valid version number.');
|
||||
}
|
||||
|
||||
if (semver.lte(value, currentVersion)) {
|
||||
return chalk.red(
|
||||
`Please enter a version number greater than the current version (${currentVersion}).`,
|
||||
);
|
||||
}
|
||||
|
||||
return true;
|
||||
},
|
||||
});
|
||||
|
||||
console.log(chalk.green(`New version set to: ${newVersion}`));
|
||||
|
||||
return newVersion;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the current version number from the manifest files.
|
||||
* This function reads the version from the first manifest file and assumes that all manifest files have the same version.
|
||||
* @returns A promise that resolves to the current version number read from the manifest files.
|
||||
*/
|
||||
async function getCurrentVersion(): Promise<string> {
|
||||
const manifest = JSON.parse(await readFile(manifestPaths[0], 'utf-8'));
|
||||
return manifest.version;
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates the manifest files with the new version number.
|
||||
* This function reads each manifest file, updates the version number, and then writes the file back to disk.
|
||||
* @param newVersion The new version number to set in the manifest files.
|
||||
* @returns A promise that resolves when all manifest files have been updated.
|
||||
*/
|
||||
async function updateManifests(newVersion: string): Promise<void> {
|
||||
console.log('');
|
||||
console.log(chalk.blue(`Updating manifest files to version ${newVersion}...`));
|
||||
for (const manifestPath of manifestPaths) {
|
||||
const manifest = JSON.parse(await readFile(manifestPath, 'utf-8'));
|
||||
manifest.version = newVersion;
|
||||
await writeFile(manifestPath, JSON.stringify(manifest, null, 2) + '\n');
|
||||
console.log(`- Updated version for manifest in: ${manifestPath}`);
|
||||
}
|
||||
console.log(chalk.green('Manifest files updated successfully.'));
|
||||
}
|
||||
|
||||
/**
|
||||
* Prepares the release pull request.
|
||||
* This function creates a new branch, stages the changes to the manifest files, commits the changes, and then pushes the branch to the user's fork.
|
||||
* @param newVersion The new version number for which the release PR is being prepared.
|
||||
* @returns A promise that resolves when the release branch has been created and pushed.
|
||||
*/
|
||||
async function prepareReleasePullRequest(newVersion: string): Promise<void> {
|
||||
console.log('');
|
||||
console.log(chalk.blue('Creating release commit...'));
|
||||
const releaseBranch = `devtools-release-${newVersion}`;
|
||||
await exec(`git branch -D ${releaseBranch}`).catch(() => {});
|
||||
await exec(`git checkout -b ${releaseBranch}`);
|
||||
await exec(`git commit -m "${releaseCommitPrefix}${newVersion}" "${manifestPaths.join('" "')}"`);
|
||||
await exec(`git push origin ${releaseBranch} --force-with-lease`);
|
||||
console.log(chalk.green('Release branch pushed to your fork.'));
|
||||
|
||||
const {stdout: remoteUrl} = await exec('git config --get remote.origin.url');
|
||||
const match = remoteUrl.trim().match(/github\.com[/:]([\w-]+)\/angular/);
|
||||
const origin = match ? match[1] : 'angular';
|
||||
|
||||
console.log(
|
||||
chalk.yellow(
|
||||
`Please create a pull request by visiting: https://github.com/${origin}/angular/compare/${releaseBranch}`,
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the SHA of the merged release commit by searching for it on the remote.
|
||||
* @param newVersion The new version number associated with the merged release commit.
|
||||
* @returns A promise that resolves to the SHA of the merged commit.
|
||||
*/
|
||||
async function getMergedCommitSha(newVersion: string): Promise<string> {
|
||||
console.log('');
|
||||
console.log('Waiting for release PR to be merged...');
|
||||
await input({
|
||||
message: 'Press Enter once the release PR has been merged.',
|
||||
});
|
||||
|
||||
console.log(chalk.blue('Fetching latest changes from upstream...'));
|
||||
await exec(`git fetch ${angularRepoRemote} main`);
|
||||
console.log(chalk.green('Successfully fetched latest changes.'));
|
||||
|
||||
console.log(chalk.blue('Finding merged release commit...'));
|
||||
const mergedCommitSha = await getLastReleaseSha(newVersion);
|
||||
|
||||
console.log(chalk.green(`Found merged release commit: ${mergedCommitSha}`));
|
||||
return mergedCommitSha;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks out the merged commit and installs dependencies.
|
||||
* @param mergedCommitSha The SHA of the merged release commit.
|
||||
*/
|
||||
async function checkoutMergedCommitAndInstallDependencies(mergedCommitSha: string): Promise<void> {
|
||||
console.log('');
|
||||
console.log(
|
||||
chalk.blue(`Checking out merged commit ${mergedCommitSha} and installing dependencies...`),
|
||||
);
|
||||
await exec(`git fetch ${angularRepoRemote}`);
|
||||
await exec(`git checkout ${mergedCommitSha}`);
|
||||
await execAndStream('pnpm', ['install', '--frozen-lockfile']);
|
||||
console.log(chalk.green('Successfully checked out merged commit and installed dependencies.'));
|
||||
}
|
||||
|
||||
/**
|
||||
* Publishes the Chrome extension.
|
||||
* This function builds the Chrome extension, packages it, and then opens the Chrome Web Store in the browser.
|
||||
* @param chromeZipPath The absolute path where the Chrome extension zip file will be created.
|
||||
* @returns A promise that resolves when the Chrome extension has been built and packaged.
|
||||
*/
|
||||
async function publishChromeExtension(chromeZipPath: string): Promise<void> {
|
||||
console.log('');
|
||||
console.log(chalk.blue('Building Chrome extension...'));
|
||||
await execAndStream('pnpm', ['devtools:build:chrome:release', ...additionBazelReleaseArgs]);
|
||||
await exec(`zip -r ${join(rootPath, chromeZipPath)} *`, {
|
||||
cwd: extensionPath,
|
||||
});
|
||||
console.log(chalk.green(`Chrome extension packaged at ${chromeZipPath}`));
|
||||
console.log(chalk.yellow('Please upload the extension to the Chrome Web Store.'));
|
||||
console.log(`You can do so here: ${chromeWebStoreUrl}`);
|
||||
console.log(`Make sure you are a member of the publisher group: ${publisherGoogleGroupUrl}`);
|
||||
}
|
||||
|
||||
/**
|
||||
* Publishes the Firefox extension.
|
||||
* This function builds the Firefox extension, packages it, and then opens the Firefox Add-ons page in the browser.
|
||||
* It also packages the source code and generates the changelog and reviewer note.
|
||||
* @param mergedCommitSha The SHA of the merged release commit.
|
||||
* @param firefoxZipPath The absolute path where the Firefox extension zip file will be created.
|
||||
* @param sourceZipPath The absolute path where the source code zip file will be created.
|
||||
* @param commits A list of commit messages since the last release.
|
||||
* @returns A promise that resolves when the Firefox extension has been built and packaged.
|
||||
*/
|
||||
async function publishFirefoxExtension(
|
||||
mergedCommitSha: string,
|
||||
firefoxZipPath: string,
|
||||
sourceZipPath: string,
|
||||
commits: string[],
|
||||
): Promise<void> {
|
||||
console.log('');
|
||||
console.log(chalk.blue('Building Firefox extension...'));
|
||||
await execAndStream('pnpm', ['devtools:build:firefox:release', ...additionBazelReleaseArgs]);
|
||||
await exec(`zip -r ${join(rootPath, firefoxZipPath)} *`, {
|
||||
cwd: extensionPath,
|
||||
});
|
||||
console.log(chalk.green(`Firefox extension packaged at ${firefoxZipPath}`));
|
||||
|
||||
console.log(chalk.blue('Packaging source code...'));
|
||||
await exec(`git archive FETCH_HEAD -o "${sourceZipPath}"`);
|
||||
console.log(chalk.green(`Source code packaged at ${sourceZipPath}`));
|
||||
console.log('');
|
||||
|
||||
const changelog = generateChangelog(commits);
|
||||
console.log(chalk.blue('Changelog:'));
|
||||
console.log(changelog);
|
||||
console.log('');
|
||||
|
||||
const reviewerNote = getFirefoxReviewerNote(mergedCommitSha);
|
||||
console.log(chalk.blue('Reviewer note:'));
|
||||
console.log(reviewerNote);
|
||||
console.log('');
|
||||
|
||||
console.log(chalk.yellow('Please upload the extension to the Firefox Add-ons page.'));
|
||||
console.log(`You can do so here: ${firefoxAddonsUrl}`);
|
||||
console.log(
|
||||
`This will require a 2FA code, which you can generate by installing Google Authenticator: ${googleAuthenticatorUrl}`,
|
||||
);
|
||||
console.log(`Login credentials: ${firefoxCredentialsUrl}`);
|
||||
console.log(`2FA QR code: ${firefox2faUrl}`);
|
||||
console.log('');
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates the changelog for the release.
|
||||
* This function gets the commits since the last release and formats them into a changelog.
|
||||
* @param commits A list of commit messages since the last release.
|
||||
* @returns The changelog for the release.
|
||||
*/
|
||||
function generateChangelog(commits: string[]): string {
|
||||
return commits
|
||||
.map(
|
||||
(commit) =>
|
||||
`* ${commit.replace(/\(#(\d+)\)/, '([#$1](https://github.com/angular/angular/pull/$1))')}`,
|
||||
)
|
||||
.join('\n');
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates the reviewer note that is submitted with the Firefox extension.
|
||||
* This is displayed to the user to help them write the reviewer note.
|
||||
* @param commitSha The SHA of the release commit.
|
||||
* @returns The reviewer note.
|
||||
*/
|
||||
function getFirefoxReviewerNote(commitSha: string): string {
|
||||
return `There is a field to provide a note to the reviewer, copy this template and make sure to replace
|
||||
${commitSha} with the SHA of the release commit to create a valid link.
|
||||
|
||||
This is a monorepo and includes much more code than just the DevTools extension. The relevant
|
||||
code is under \`devtools/...\` and \`devtools/README.md\` contains instructions for compiling
|
||||
release builds locally.
|
||||
|
||||
The uploaded source is equivalent to:
|
||||
https://github.com/angular/angular/tree/${commitSha}/.
|
||||
`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Executes a command and streams its stdout and stderr.
|
||||
* @param command The command to execute.
|
||||
* @param args The arguments to pass to the command.
|
||||
* @param options The options to pass to spawn.
|
||||
* @returns A promise that resolves when the command has finished.
|
||||
*/
|
||||
function execAndStream(command: string, args: string[], options: SpawnOptions = {}): Promise<void> {
|
||||
return new Promise((resolve, reject) => {
|
||||
const child = spawn(`${command} ${args.join(' ')}`, [], {
|
||||
...options,
|
||||
stdio: 'inherit',
|
||||
shell: true,
|
||||
});
|
||||
|
||||
child.on('close', (code) => {
|
||||
if (code === 0) {
|
||||
resolve();
|
||||
} else {
|
||||
reject(new Error(`Command "${command} ${args.join(' ')}" failed with exit code ${code}`));
|
||||
}
|
||||
});
|
||||
child.on('error', reject);
|
||||
});
|
||||
}
|
||||
|
||||
// Start the release process.
|
||||
main().catch((err) => {
|
||||
console.error(chalk.red(err));
|
||||
process.exit(1);
|
||||
});
|
||||
@@ -41,6 +41,7 @@
|
||||
"devtools:build:firefox:release": "pnpm run -s devtools:build:firefox --jobs 4",
|
||||
"devtools:test": "bazelisk test --//devtools/projects/shell-browser/src:flag_browser=chrome -- //devtools/...",
|
||||
"devtools:test:unit": "bazelisk test -- //devtools/...",
|
||||
"devtools:release": "tsx --tsconfig=devtools/tsconfig.json devtools/tools/release.mts",
|
||||
"adev": "[[ -n $CI ]] && echo 'Cannot run this pnpm script on CI' && exit 1 || ibazel run //adev:build.serve",
|
||||
"adev:build": "[[ -n $CI ]] && echo 'Cannot run this pnpm script on CI' && exit 1 || bazel build //adev:build",
|
||||
"benchmarks": "tsx --tsconfig=scripts/tsconfig.json scripts/benchmarks/index.mts",
|
||||
|
||||
Reference in New Issue
Block a user