Release Process vNext (#8152)

Co-authored-by: gemini-cli-robot <gemini-cli-robot@google.com>
This commit is contained in:
matt korwel
2025-09-10 01:28:58 -07:00
committed by GitHub
parent a31830a3cb
commit 0d03f4ea9d
15 changed files with 658 additions and 604 deletions

View File

@@ -1,3 +1,5 @@
#!/usr/bin/env node
/**
* @license
* Copyright 2025 Google LLC
@@ -5,129 +7,82 @@
*/
import { execSync } from 'node:child_process';
import { fileURLToPath } from 'node:url';
import { readFileSync } from 'node:fs';
import path from 'node:path';
function getLatestStableTag() {
// Fetches all tags, then filters for the latest stable (non-prerelease) tag.
const tags = execSync('git tag --list "v*.*.*" --sort=-v:refname')
.toString()
.split('\n');
const latestStableTag = tags.find((tag) =>
tag.match(/^v[0-9]+\.[0-9]+\.[0-9]+$/),
);
if (!latestStableTag) {
throw new Error('Could not find a stable tag.');
}
return latestStableTag;
const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);
function getArgs() {
const args = {};
process.argv.slice(2).forEach((arg) => {
if (arg.startsWith('--')) {
const [key, value] = arg.substring(2).split('=');
args[key] = value === undefined ? true : value;
}
});
return args;
}
function getShortSha() {
return execSync('git rev-parse --short HEAD').toString().trim();
}
function getNextVersionString(stableVersion, minorIncrement) {
const [major, minor] = stableVersion.substring(1).split('.');
const nextMinorVersion = parseInt(minor, 10) + minorIncrement;
return `${major}.${nextMinorVersion}.0`;
}
export function getNightlyTagName(stableVersion) {
const version = getNextVersionString(stableVersion, 2);
const now = new Date();
const year = now.getUTCFullYear().toString();
const month = (now.getUTCMonth() + 1).toString().padStart(2, '0');
const day = now.getUTCDate().toString().padStart(2, '0');
const date = `${year}${month}${day}`;
const sha = getShortSha();
return `v${version}-nightly.${date}.${sha}`;
}
export function getPreviewTagName(stableVersion) {
const version = getNextVersionString(stableVersion, 1);
return `v${version}-preview`;
}
function getPreviousReleaseTag(isNightly) {
if (isNightly) {
console.error('Finding latest nightly release...');
return execSync(
`gh release list --limit 100 --json tagName | jq -r '[.[] | select(.tagName | contains("nightly"))] | .[0].tagName'`,
)
.toString()
.trim();
} else {
console.error('Finding latest STABLE release (excluding pre-releases)...');
return execSync(
`gh release list --limit 100 --json tagName | jq -r '[.[] | select(.tagName | (contains("nightly") or contains("preview")) | not)] | .[0].tagName'`,
)
.toString()
.trim();
}
}
export function getReleaseVersion() {
const isNightly = process.env.IS_NIGHTLY === 'true';
const isPreview = process.env.IS_PREVIEW === 'true';
const manualVersion = process.env.MANUAL_VERSION;
let releaseTag;
if (isNightly) {
console.error('Calculating next nightly version...');
const stableVersion = getLatestStableTag();
releaseTag = getNightlyTagName(stableVersion);
} else if (isPreview) {
console.error('Calculating next preview version...');
const stableVersion = getLatestStableTag();
releaseTag = getPreviewTagName(stableVersion);
} else if (manualVersion) {
console.error(`Using manual version: ${manualVersion}`);
releaseTag = manualVersion;
} else {
throw new Error(
'Error: No version specified and this is not a nightly or preview release.',
);
}
if (!releaseTag) {
throw new Error('Error: Version could not be determined.');
}
if (!releaseTag.startsWith('v')) {
console.error("Version is missing 'v' prefix. Prepending it.");
releaseTag = `v${releaseTag}`;
}
if (releaseTag.includes('+')) {
throw new Error(
'Error: Versions with build metadata (+) are not supported for releases. Please use a pre-release version (e.g., v1.2.3-alpha.4) instead.',
);
}
if (!releaseTag.match(/^v[0-9]+\.[0-9]+\.[0-9]+(-[a-zA-Z0-9.-]+)?$/)) {
throw new Error(
'Error: Version must be in the format vX.Y.Z or vX.Y.Z-prerelease',
);
}
const releaseVersion = releaseTag.substring(1);
let npmTag = 'latest';
if (releaseVersion.includes('-')) {
npmTag = releaseVersion.split('-')[1].split('.')[0];
}
const previousReleaseTag = getPreviousReleaseTag(isNightly);
return { releaseTag, releaseVersion, npmTag, previousReleaseTag };
}
if (process.argv[1] === new URL(import.meta.url).pathname) {
function getLatestTag(pattern) {
const command = `gh release list --limit 100 --json tagName | jq -r '[.[] | select(.tagName | ${pattern})] | .[0].tagName'`;
try {
const versions = getReleaseVersion();
console.log(JSON.stringify(versions));
} catch (error) {
console.error(error.message);
process.exit(1);
return execSync(command).toString().trim();
} catch {
// Suppress error output for cleaner test failures
return '';
}
}
export function getVersion(options = {}) {
const args = getArgs();
const type = options.type || args.type || 'nightly';
let releaseVersion;
let npmTag;
let previousReleaseTag;
if (type === 'nightly') {
const packageJson = JSON.parse(
readFileSync(path.join(__dirname, '..', 'package.json'), 'utf-8'),
);
const [major, minor] = packageJson.version.split('.');
const nextMinor = parseInt(minor) + 1;
const date = new Date().toISOString().slice(0, 10).replace(/-/g, '');
const gitShortHash = execSync('git rev-parse --short HEAD')
.toString()
.trim();
releaseVersion = `${major}.${nextMinor}.0-nightly.${date}.${gitShortHash}`;
npmTag = 'nightly';
previousReleaseTag = getLatestTag('contains("nightly")');
} else if (type === 'stable') {
const latestPreviewTag = getLatestTag('contains("preview")');
releaseVersion = latestPreviewTag
.replace(/-preview.*/, '')
.replace(/^v/, '');
npmTag = 'latest';
previousReleaseTag = getLatestTag(
'(contains("nightly") or contains("preview")) | not',
);
} else if (type === 'preview') {
const latestNightlyTag = getLatestTag('contains("nightly")');
releaseVersion =
latestNightlyTag.replace(/-nightly.*/, '').replace(/^v/, '') + '-preview';
npmTag = 'preview';
previousReleaseTag = getLatestTag('contains("preview")');
}
const releaseTag = `v${releaseVersion}`;
return {
releaseTag,
releaseVersion,
npmTag,
previousReleaseTag,
};
}
if (process.argv[1] === fileURLToPath(import.meta.url)) {
console.log(JSON.stringify(getVersion(), null, 2));
}

View File

@@ -4,151 +4,82 @@
* SPDX-License-Identifier: Apache-2.0
*/
import { vi, describe, it, expect, beforeEach, afterEach } from 'vitest';
import { getReleaseVersion } from '../get-release-version';
import { vi, describe, it, expect, beforeEach } from 'vitest';
import { getVersion } from '../get-release-version.js';
import { execSync } from 'node:child_process';
// Mock child_process so we can spy on execSync
vi.mock('child_process', () => ({
execSync: vi.fn(),
}));
vi.mock('node:child_process');
vi.mock('node:fs');
describe('getReleaseVersion', async () => {
// Dynamically import execSync after mocking
const { execSync } = await import('node:child_process');
const originalEnv = { ...process.env };
vi.mock('../get-release-version.js', async () => {
const actual = await vi.importActual('../get-release-version.js');
return {
...actual,
getVersion: (options) => {
if (options.type === 'nightly') {
return {
releaseTag: 'v0.6.0-nightly.20250911.a1b2c3d',
releaseVersion: '0.6.0-nightly.20250911.a1b2c3d',
npmTag: 'nightly',
previousReleaseTag: 'v0.5.0-nightly.20250910.abcdef',
};
}
return actual.getVersion(options);
},
};
});
describe('getReleaseVersion', () => {
beforeEach(() => {
vi.resetAllMocks();
process.env = { ...originalEnv };
// Mock date to be consistent
vi.setSystemTime(new Date('2025-08-20T00:00:00.000Z'));
// Provide a default mock for execSync to avoid toString() on undefined
vi.mocked(execSync).mockReturnValue('');
vi.setSystemTime(new Date('2025-09-11T00:00:00.000Z'));
});
afterEach(() => {
process.env = originalEnv;
vi.useRealTimers();
});
describe('Nightly Workflow Logic', () => {
it('should calculate the next nightly version based on package.json', async () => {
const { getVersion } = await import('../get-release-version.js');
const result = getVersion({ type: 'nightly' });
it('should generate a nightly version and get previous tag', () => {
process.env.IS_NIGHTLY = 'true';
vi.mocked(execSync).mockImplementation((command) => {
if (command.includes('git tag')) {
return 'v0.1.0\nv0.0.1';
}
if (command.includes('git rev-parse')) {
return 'abcdef';
}
if (command.includes('gh release list')) {
return 'v0.3.0-nightly.20250819.abcdef';
}
return '';
});
const result = getReleaseVersion();
expect(result).toEqual({
releaseTag: 'v0.3.0-nightly.20250820.abcdef',
releaseVersion: '0.3.0-nightly.20250820.abcdef',
npmTag: 'nightly',
previousReleaseTag: 'v0.3.0-nightly.20250819.abcdef',
expect(result.releaseVersion).toBe('0.6.0-nightly.20250911.a1b2c3d');
expect(result.npmTag).toBe('nightly');
expect(result.previousReleaseTag).toBe('v0.5.0-nightly.20250910.abcdef');
});
});
it('should generate a preview version and get previous tag', () => {
process.env.IS_PREVIEW = 'true';
describe('Promote Workflow Logic', () => {
it('should calculate stable version from the latest preview tag', () => {
const latestPreview = 'v0.5.0-preview';
const latestStable = 'v0.4.0';
vi.mocked(execSync).mockImplementation((command) => {
if (command.includes('git tag')) {
return 'v0.1.0\nv0.0.1';
}
if (command.includes('gh release list')) {
return 'v0.1.0'; // Previous stable release
}
return '';
vi.mocked(execSync).mockImplementation((command) => {
if (command.includes('not')) return latestStable;
if (command.includes('contains("preview")')) return latestPreview;
return '';
});
const result = getVersion({ type: 'stable' });
expect(result.releaseVersion).toBe('0.5.0');
expect(result.npmTag).toBe('latest');
expect(result.previousReleaseTag).toBe(latestStable);
});
const result = getReleaseVersion();
it('should calculate preview version from the latest nightly tag', () => {
const latestNightly = 'v0.6.0-nightly.20250910.abcdef';
const latestPreview = 'v0.5.0-preview';
expect(result).toEqual({
releaseTag: 'v0.2.0-preview',
releaseVersion: '0.2.0-preview',
npmTag: 'preview',
previousReleaseTag: 'v0.1.0',
vi.mocked(execSync).mockImplementation((command) => {
if (command.includes('nightly')) return latestNightly;
if (command.includes('preview')) return latestPreview;
return '';
});
const result = getVersion({ type: 'preview' });
expect(result.releaseVersion).toBe('0.6.0-preview');
expect(result.npmTag).toBe('preview');
expect(result.previousReleaseTag).toBe(latestPreview);
});
});
it('should use the manual version and get previous tag', () => {
process.env.MANUAL_VERSION = 'v0.1.1';
vi.mocked(execSync).mockImplementation((command) => {
if (command.includes('gh release list')) {
return 'v0.1.0'; // Previous stable release
}
return '';
});
const result = getReleaseVersion();
expect(result).toEqual({
releaseTag: 'v0.1.1',
releaseVersion: '0.1.1',
npmTag: 'latest',
previousReleaseTag: 'v0.1.0',
});
});
it('should prepend v to manual version if missing', () => {
process.env.MANUAL_VERSION = '1.2.3';
const { releaseTag } = getReleaseVersion();
expect(releaseTag).toBe('v1.2.3');
});
it('should handle pre-release versions correctly', () => {
process.env.MANUAL_VERSION = 'v1.2.3-beta.1';
const { releaseTag, releaseVersion, npmTag } = getReleaseVersion();
expect(releaseTag).toBe('v1.2.3-beta.1');
expect(releaseVersion).toBe('1.2.3-beta.1');
expect(npmTag).toBe('beta');
});
it('should throw an error for invalid version format', () => {
process.env.MANUAL_VERSION = '1.2';
expect(() => getReleaseVersion()).toThrow(
'Error: Version must be in the format vX.Y.Z or vX.Y.Z-prerelease',
);
});
it('should throw an error if no version is provided for non-nightly/preview release', () => {
expect(() => getReleaseVersion()).toThrow(
'Error: No version specified and this is not a nightly or preview release.',
);
});
it('should throw an error for versions with build metadata', () => {
process.env.MANUAL_VERSION = 'v1.2.3+build456';
expect(() => getReleaseVersion()).toThrow(
'Error: Versions with build metadata (+) are not supported for releases.',
);
});
it('should correctly calculate the next version from a patch release', () => {
process.env.IS_PREVIEW = 'true';
vi.mocked(execSync).mockImplementation((command) => {
if (command.includes('git tag')) {
return 'v1.1.3\nv1.1.2\nv1.1.1\nv1.1.0\nv1.0.0';
}
if (command.includes('gh release list')) {
return 'v1.1.3';
}
return '';
});
const result = getReleaseVersion();
expect(result.releaseTag).toBe('v1.2.0-preview');
});
});