-
-
Notifications
You must be signed in to change notification settings - Fork 305
fix: calculate next version tag for display on home page #1898
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.
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
+187
−85
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| /** | ||
| * Calculates the next semantic version based on conventional commits since the | ||
| * last reachable `v*` tag. | ||
| * | ||
| * Zero external dependencies — uses `child_process` to shell out to `git`. | ||
| * | ||
| * ### Imported as a module | ||
| * | ||
| * ```ts | ||
| * import { getNextVersion } from './scripts/next-version' | ||
| * const { current, next, from } = await getNextVersion() | ||
| * ``` | ||
| * | ||
| * ### CLI usage (outputs JSON to stdout) | ||
| * | ||
| * ```sh | ||
| * node scripts/next-version.ts # { "current": "0.1.0", "next": "0.2.0", "from": "v0.1.0" } | ||
| * node scripts/next-version.ts --next # 0.2.0 | ||
| * node scripts/next-version.ts --current # 0.1.0 | ||
| * node scripts/next-version.ts --from # v0.1.0 | ||
| * ``` | ||
| */ | ||
|
|
||
| import { execFileSync } from 'node:child_process' | ||
|
|
||
| function git(...args: string[]): string { | ||
| return execFileSync('git', args, { encoding: 'utf-8', stdio: ['pipe', 'pipe', 'pipe'] }).trim() | ||
| } | ||
|
|
||
| export interface VersionInfo { | ||
| /** The current version (from the latest tag), e.g. `"0.1.0"` */ | ||
| current: string | ||
| /** The computed next version, e.g. `"0.2.0"` */ | ||
| next: string | ||
| /** The git ref used as the starting point, e.g. `"v0.1.0"` or an initial commit SHA */ | ||
| from: string | ||
| } | ||
|
|
||
| export async function getNextVersion(): Promise<VersionInfo> { | ||
| let current: string | ||
| let from: string | ||
|
|
||
| try { | ||
| const tag = git('describe', '--tags', '--abbrev=0', '--match', 'v*') | ||
| current = tag.replace(/^v/, '') | ||
| from = tag | ||
| } catch { | ||
| // No reachable tags — start from the initial commit | ||
| current = '0.0.0' | ||
| from = git('rev-list', '--max-parents=0', 'HEAD') | ||
| } | ||
|
|
||
| // Collect commit subjects since last tag (exclude merges) | ||
| let commits: string[] | ||
| try { | ||
| const log = git('log', `${from}..HEAD`, '--format=%s%n%b', '--no-merges') | ||
| commits = log ? log.split('\n') : [] | ||
| } catch { | ||
| commits = [] | ||
| } | ||
|
|
||
| let hasBreaking = false | ||
| let hasFeat = false | ||
| let hasFix = false | ||
|
|
||
| for (const line of commits) { | ||
| if (/BREAKING CHANGE|!:/.test(line)) hasBreaking = true | ||
| if (/^feat(?:\([^)]*\))?!?:/.test(line)) hasFeat = true | ||
| if (/^fix(?:\([^)]*\))?!?:/.test(line)) hasFix = true | ||
| } | ||
|
|
||
| const [major = 0, minor = 0, patch = 0] = current.split('.').map(Number) | ||
|
|
||
| let next: string | ||
| if (hasBreaking) { | ||
| next = major > 0 ? `${major + 1}.0.0` : `${major}.${minor + 1}.0` | ||
| } else if (hasFeat) { | ||
| next = `${major}.${minor + 1}.0` | ||
| } else if (hasFix || commits.length > 0) { | ||
| // Any non-empty diff bumps at least a patch | ||
| next = `${major}.${minor}.${patch + 1}` | ||
| } else { | ||
| // HEAD is exactly on the latest tag | ||
| next = current | ||
| } | ||
|
|
||
| return { current, next, from } | ||
| } | ||
|
|
||
| // --- CLI entry point --- | ||
| const isCLI = | ||
| process.argv[1] && | ||
| (process.argv[1].endsWith('/next-version.ts') || process.argv[1].endsWith('/next-version')) | ||
|
|
||
| if (isCLI) { | ||
| const flag = process.argv[2] | ||
| getNextVersion() | ||
| .then(info => { | ||
| if (flag === '--next') console.log(info.next) | ||
| else if (flag === '--current') console.log(info.current) | ||
| else if (flag === '--from') console.log(info.from) | ||
| else console.log(JSON.stringify(info)) | ||
| }) | ||
| .catch(err => { | ||
| console.error(err) | ||
| process.exit(1) | ||
| }) | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| import { describe, expect, it } from 'vitest' | ||
| import { getNextVersion } from '../../../scripts/next-version' | ||
|
|
||
| describe('getNextVersion', () => { | ||
| it('returns current, next, and from fields', async () => { | ||
| const result = await getNextVersion() | ||
|
|
||
| expect(result).toHaveProperty('current') | ||
| expect(result).toHaveProperty('next') | ||
| expect(result).toHaveProperty('from') | ||
| }) | ||
|
|
||
| it('returns valid semver strings', async () => { | ||
| const result = await getNextVersion() | ||
|
|
||
| expect(result.current).toMatch(/^\d+\.\d+\.\d+$/) | ||
| expect(result.next).toMatch(/^\d+\.\d+\.\d+$/) | ||
| }) | ||
|
|
||
| it('returns a next version >= current version', async () => { | ||
| const result = await getNextVersion() | ||
|
|
||
| const [curMajor, curMinor, curPatch] = result.current.split('.').map(Number) | ||
| const [nextMajor, nextMinor, nextPatch] = result.next.split('.').map(Number) | ||
|
|
||
| const curNum = curMajor! * 1_000_000 + curMinor! * 1_000 + curPatch! | ||
| const nextNum = nextMajor! * 1_000_000 + nextMinor! * 1_000 + nextPatch! | ||
|
|
||
| expect(nextNum).toBeGreaterThanOrEqual(curNum) | ||
| }) | ||
| }) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.