From 0e2480580648788f824a6fd7f76ad452bb6cf771 Mon Sep 17 00:00:00 2001 From: matt korwel Date: Wed, 20 Aug 2025 08:50:00 -0700 Subject: [PATCH] feat(release): update release process for nightly and preview builds (#6643) Co-authored-by: Bryan Morgan --- .github/workflows/release.yml | 39 +++--- scripts/get-release-version.js | 68 +++++++++-- scripts/tests/get-release-version.test.js | 137 ++++++++++++++-------- 3 files changed, 166 insertions(+), 78 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 6c5ed376..25a1ab37 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -4,6 +4,8 @@ on: schedule: # Runs every day at midnight UTC for the nightly release. - cron: '0 0 * * *' + # Runs every Tuesday at 23:59 UTC for the preview release. + - cron: '59 23 * * 2' workflow_dispatch: inputs: version: @@ -25,6 +27,11 @@ on: required: false type: 'boolean' default: false + create_preview_release: + description: 'Auto apply the preview release tag, input version is ignored.' + required: false + type: 'boolean' + default: false force_skip_tests: description: 'Select to skip the "Run Tests" step in testing. Prod releases should run tests' required: false @@ -57,16 +64,24 @@ jobs: - name: 'Set booleans for simplified logic' env: CREATE_NIGHTLY_RELEASE: '${{ github.event.inputs.create_nightly_release }}' + CREATE_PREVIEW_RELEASE: '${{ github.event.inputs.create_preview_release }}' EVENT_NAME: '${{ github.event_name }}' + CRON: '${{ github.event.schedule }}' DRY_RUN_INPUT: '${{ github.event.inputs.dry_run }}' id: 'vars' run: |- is_nightly="false" - if [[ "${EVENT_NAME}" == "schedule" || "${CREATE_NIGHTLY_RELEASE}" == "true" ]]; then + if [[ "${CRON}" == "0 0 * * *" || "${CREATE_NIGHTLY_RELEASE}" == "true" ]]; then is_nightly="true" fi echo "is_nightly=${is_nightly}" >> "${GITHUB_OUTPUT}" + is_preview="false" + if [[ "${CRON}" == "59 23 * * 2" || "${CREATE_PREVIEW_RELEASE}" == "true" ]]; then + is_preview="true" + fi + echo "is_preview=${is_preview}" >> "${GITHUB_OUTPUT}" + is_dry_run="false" if [[ "${DRY_RUN_INPUT}" == "true" ]]; then is_dry_run="true" @@ -86,13 +101,16 @@ jobs: - name: 'Get the version' id: 'version' env: + GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}' IS_NIGHTLY: '${{ steps.vars.outputs.is_nightly }}' + IS_PREVIEW: '${{ steps.vars.outputs.is_preview }}' MANUAL_VERSION: '${{ inputs.version }}' run: |- VERSION_JSON="$(node scripts/get-release-version.js)" echo "RELEASE_TAG=$(echo "${VERSION_JSON}" | jq -r .releaseTag)" >> "${GITHUB_OUTPUT}" echo "RELEASE_VERSION=$(echo "${VERSION_JSON}" | jq -r .releaseVersion)" >> "${GITHUB_OUTPUT}" echo "NPM_TAG=$(echo "${VERSION_JSON}" | jq -r .npmTag)" >> "${GITHUB_OUTPUT}" + echo "PREVIOUS_TAG=$(echo "${VERSION_JSON}" | jq -r .previousReleaseTag)" >> "${GITHUB_OUTPUT}" - name: 'Run Tests' if: |- @@ -183,23 +201,6 @@ jobs: --workspace="@google/gemini-cli" \ --tag="${NPM_TAG}" - - name: 'Get previous release tag' - id: 'previous_release' - if: |- - ${{ steps.vars.outputs.is_dry_run == 'false' }} - env: - GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}' - IS_NIGHTLY: '${{ steps.vars.outputs.is_nightly }}' - run: |- - if [[ "${IS_NIGHTLY}" == "true" ]]; then - echo "Finding latest nightly release..." - PREVIOUS_TAG=$(gh release list --limit 100 --json tagName | jq -r '[.[] | select(.tagName | contains("nightly"))] | .[0].tagName') - else - echo "Finding latest STABLE release (excluding pre-releases)..." - PREVIOUS_TAG=$(gh release list --limit 100 --json tagName | jq -r '[.[] | select(.tagName | contains("nightly") | not)] | .[0].tagName') - fi - echo "PREVIOUS_TAG=${PREVIOUS_TAG}" >> "$GITHUB_OUTPUT" - - name: 'Create GitHub Release and Tag' if: |- ${{ steps.vars.outputs.is_dry_run == 'false' }} @@ -207,7 +208,7 @@ jobs: GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}' RELEASE_BRANCH: '${{ steps.release_branch.outputs.BRANCH_NAME }}' RELEASE_TAG: '${{ steps.version.outputs.RELEASE_TAG }}' - PREVIOUS_TAG: '${{ steps.previous_release.outputs.PREVIOUS_TAG }}' + PREVIOUS_TAG: '${{ steps.version.outputs.PREVIOUS_TAG }}' run: |- gh release create "${RELEASE_TAG}" \ bundle/gemini.js \ diff --git a/scripts/get-release-version.js b/scripts/get-release-version.js index 5aee50c4..7b776822 100644 --- a/scripts/get-release-version.js +++ b/scripts/get-release-version.js @@ -5,23 +5,36 @@ */ import { execSync } from 'child_process'; -import fs from 'fs'; -import path from 'path'; -function getPackageVersion() { - const packageJsonPath = path.resolve(process.cwd(), 'package.json'); - const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8')); - return packageJson.version; +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; } function getShortSha() { return execSync('git rev-parse --short HEAD').toString().trim(); } -export function getNightlyTagName() { - const version = getPackageVersion(); +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().slice(-2); + 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}`; @@ -30,21 +43,50 @@ export function getNightlyTagName() { 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...'); - releaseTag = getNightlyTagName(); + 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 release.', + 'Error: No version specified and this is not a nightly or preview release.', ); } @@ -75,7 +117,9 @@ export function getReleaseVersion() { npmTag = releaseVersion.split('-')[1].split('.')[0]; } - return { releaseTag, releaseVersion, npmTag }; + const previousReleaseTag = getPreviousReleaseTag(isNightly); + + return { releaseTag, releaseVersion, npmTag, previousReleaseTag }; } if (process.argv[1] === new URL(import.meta.url).pathname) { diff --git a/scripts/tests/get-release-version.test.js b/scripts/tests/get-release-version.test.js index 10744770..fdc30456 100644 --- a/scripts/tests/get-release-version.test.js +++ b/scripts/tests/get-release-version.test.js @@ -6,59 +6,98 @@ import { vi, describe, it, expect, beforeEach, afterEach } from 'vitest'; import { getReleaseVersion } from '../get-release-version'; -import { execSync } from 'child_process'; -import * as fs from 'fs'; +// Mock child_process so we can spy on execSync vi.mock('child_process', () => ({ execSync: vi.fn(), })); -vi.mock('fs', async (importOriginal) => { - const mod = await importOriginal(); - return { - ...mod, - default: { - ...mod.default, - readFileSync: vi.fn(), - }, - }; -}); - -describe('getReleaseVersion', () => { +describe('getReleaseVersion', async () => { + // Dynamically import execSync after mocking + const { execSync } = await import('child_process'); const originalEnv = { ...process.env }; beforeEach(() => { - vi.resetModules(); + vi.resetAllMocks(); process.env = { ...originalEnv }; - vi.useFakeTimers(); + // 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(''); }); afterEach(() => { process.env = originalEnv; - vi.clearAllMocks(); vi.useRealTimers(); }); - it('should calculate nightly version when IS_NIGHTLY is true', () => { + it('should generate a nightly version and get previous tag', () => { process.env.IS_NIGHTLY = 'true'; - const knownDate = new Date('2025-07-20T10:00:00.000Z'); - vi.setSystemTime(knownDate); - vi.mocked(fs.default.readFileSync).mockReturnValue( - JSON.stringify({ version: '0.1.0' }), - ); - vi.mocked(execSync).mockReturnValue('abcdef'); - const { releaseTag, releaseVersion, npmTag } = getReleaseVersion(); - expect(releaseTag).toBe('v0.1.0-nightly.250720.abcdef'); - expect(releaseVersion).toBe('0.1.0-nightly.250720.abcdef'); - expect(npmTag).toBe('nightly'); + + 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', + }); }); - it('should use manual version when provided', () => { - process.env.MANUAL_VERSION = '1.2.3'; - const { releaseTag, releaseVersion, npmTag } = getReleaseVersion(); - expect(releaseTag).toBe('v1.2.3'); - expect(releaseVersion).toBe('1.2.3'); - expect(npmTag).toBe('latest'); + it('should generate a preview version and get previous tag', () => { + process.env.IS_PREVIEW = 'true'; + + 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 ''; + }); + + const result = getReleaseVersion(); + + expect(result).toEqual({ + releaseTag: 'v0.2.0-preview', + releaseVersion: '0.2.0-preview', + npmTag: 'preview', + previousReleaseTag: 'v0.1.0', + }); + }); + + 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', () => { @@ -82,9 +121,9 @@ describe('getReleaseVersion', () => { ); }); - it('should throw an error if no version is provided for non-nightly release', () => { + 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 release.', + 'Error: No version specified and this is not a nightly or preview release.', ); }); @@ -94,18 +133,22 @@ describe('getReleaseVersion', () => { 'Error: Versions with build metadata (+) are not supported for releases.', ); }); -}); -describe('get-release-version script', () => { - it('should print version JSON to stdout when executed directly', () => { - const expectedJson = { - releaseTag: 'v0.1.0-nightly.20250705', - releaseVersion: '0.1.0-nightly.20250705', - npmTag: 'nightly', - }; - execSync.mockReturnValue(JSON.stringify(expectedJson)); + it('should correctly calculate the next version from a patch release', () => { + process.env.IS_PREVIEW = 'true'; - const result = execSync('node scripts/get-release-version.js').toString(); - expect(JSON.parse(result)).toEqual(expectedJson); + 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'); }); });