feat: changelog button #766
+303
−2
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
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,156 @@ | ||
| import type { ProviderId, RepoRef } from '#shared/utils/git-providers' | ||
|
|
||
| /** | ||
| * Result of checking for a release tag on a git provider | ||
| */ | ||
| export interface ReleaseTagResult { | ||
| /** Whether the release tag exists */ | ||
| exists: boolean | ||
| /** URL to the releases page if tag exists */ | ||
| url: string | null | ||
| /** The tag that was found (if any) */ | ||
| tag: string | null | ||
| } | ||
|
|
||
| /** | ||
| * Tag formats to try, in priority order (most common first) | ||
| * Placeholders: {version} for semver, {name} for package name | ||
| */ | ||
| const TAG_FORMATS = [ | ||
| 'v{version}', // v1.2.3 (most common) | ||
| '{version}', // 1.2.3 | ||
| '{name}@{version}', // package@1.2.3 (monorepos like changesets) | ||
| '{name}@v{version}', // package@v1.2.3 | ||
| ] as const | ||
|
|
||
| /** | ||
| * Get the release URL for a tag on a given provider | ||
| */ | ||
| function getReleaseUrl(ref: RepoRef, tag: string): string { | ||
| const encodedTag = encodeURIComponent(tag) | ||
|
|
||
| switch (ref.provider) { | ||
| case 'github': | ||
| return `https://github.com/${ref.owner}/${ref.repo}/releases/tag/${encodedTag}` | ||
| case 'gitlab': { | ||
| const host = ref.host ?? 'gitlab.com' | ||
| return `https://${host}/${ref.owner}/${ref.repo}/-/releases/${encodedTag}` | ||
| } | ||
| case 'codeberg': | ||
| return `https://codeberg.org/${ref.owner}/${ref.repo}/releases/tag/${encodedTag}` | ||
| case 'gitea': | ||
| case 'forgejo': { | ||
| const host = ref.host ?? 'codeberg.org' | ||
| return `https://${host}/${ref.owner}/${ref.repo}/releases/tag/${encodedTag}` | ||
| } | ||
| default: | ||
| return '' | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Get the API URL to check for a release tag | ||
| */ | ||
| function getTagCheckUrl(ref: RepoRef, tag: string): string | null { | ||
| const encodedTag = encodeURIComponent(tag) | ||
|
|
||
| switch (ref.provider) { | ||
| case 'github': | ||
| return `https://api.github.com/repos/${ref.owner}/${ref.repo}/releases/tags/${encodedTag}` | ||
| case 'gitlab': { | ||
| const host = ref.host ?? 'gitlab.com' | ||
| const encodedProject = encodeURIComponent(`${ref.owner}/${ref.repo}`) | ||
| return `https://${host}/api/v4/projects/${encodedProject}/releases/${encodedTag}` | ||
| } | ||
| case 'codeberg': | ||
| return `https://codeberg.org/api/v1/repos/${ref.owner}/${ref.repo}/releases/tags/${encodedTag}` | ||
| case 'gitea': | ||
| case 'forgejo': { | ||
| const host = ref.host ?? 'codeberg.org' | ||
| return `https://${host}/api/v1/repos/${ref.owner}/${ref.repo}/releases/tags/${encodedTag}` | ||
| } | ||
| // Bitbucket, Sourcehut, Gitee, Tangled, Radicle don't have easy release tag APIs | ||
|
Contributor
Author
There was a problem hiding this comment. This is an assumption I am making, I could use some help here on reality |
||
| default: | ||
| return null | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Generate tag candidates for a given version and package name | ||
| */ | ||
| function generateTagCandidates(version: string, packageName: string): string[] { | ||
| // Extract the short name for scoped packages: @scope/pkg -> pkg | ||
| const shortName = packageName.startsWith('@') | ||
| ? packageName.slice(packageName.indexOf('/') + 1) | ||
| : packageName | ||
|
|
||
| return TAG_FORMATS.map(format => | ||
| format.replace('{version}', version).replace('{name}', shortName), | ||
| ) | ||
| } | ||
|
|
||
| /** | ||
| * Providers that support release tag checking | ||
| */ | ||
| const SUPPORTED_PROVIDERS: Set<ProviderId> = new Set([ | ||
| 'github', | ||
| 'gitlab', | ||
| 'codeberg', | ||
| 'gitea', | ||
| 'forgejo', | ||
| ]) | ||
|
|
||
| /** | ||
| * Check if a release tag exists for a package version on the given git provider. | ||
| * Tries multiple tag formats and returns the first successful match. | ||
| * | ||
| * @param ref - Repository reference from parseRepoUrl | ||
| * @param version - Package version to check (e.g., "1.2.3") | ||
| * @param packageName - Full package name (e.g., "@scope/pkg" or "pkg") | ||
| * @returns Result indicating if a release tag exists and its URL | ||
| */ | ||
| export async function checkReleaseTag( | ||
| ref: RepoRef, | ||
| version: string, | ||
| packageName: string, | ||
| ): Promise<ReleaseTagResult> { | ||
| // Skip unsupported providers | ||
| if (!SUPPORTED_PROVIDERS.has(ref.provider)) { | ||
| return { exists: false, url: null, tag: null } | ||
| } | ||
|
|
||
| const tagCandidates = generateTagCandidates(version, packageName) | ||
|
|
||
| // Try each tag format sequentially, stop on first success | ||
| for (const tag of tagCandidates) { | ||
| const checkUrl = getTagCheckUrl(ref, tag) | ||
| if (!checkUrl) continue | ||
|
|
||
| try { | ||
| const response = await fetch(checkUrl, { | ||
| headers: { | ||
| 'Accept': 'application/json', | ||
| // GitHub API requires User-Agent | ||
| 'User-Agent': 'npmx.dev', | ||
| }, | ||
| }) | ||
|
|
||
| if (response.ok) { | ||
| // Found a release with this tag | ||
| return { | ||
| exists: true, | ||
| url: getReleaseUrl(ref, tag), | ||
| tag, | ||
| } | ||
| } | ||
| // 404 means tag doesn't exist, continue to next candidate | ||
| // Other errors we also skip and try next | ||
| } catch { | ||
| // Network error, skip this tag and try next | ||
| continue | ||
| } | ||
| } | ||
|
|
||
| // No matching tag found | ||
| return { exists: false, url: null, tag: null } | ||
| } | ||
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,48 @@ | ||
| import type { JsDelivrFileNode } from '#shared/types' | ||
|
|
||
| /** | ||
| * Changelog filenames to check (case-insensitive match, priority order) | ||
| * Based on common conventions in npm packages | ||
| */ | ||
| export const CHANGELOG_FILENAMES = [ | ||
| 'CHANGELOG.md', | ||
| 'CHANGELOG', | ||
| 'CHANGELOG.txt', | ||
| 'changelog.md', | ||
| 'changelog', | ||
| 'HISTORY.md', | ||
| 'HISTORY', | ||
| 'history.md', | ||
| 'CHANGES.md', | ||
| 'CHANGES', | ||
| 'changes.md', | ||
| 'NEWS.md', | ||
| 'RELEASES.md', | ||
| ] as const | ||
|
|
||
| /** | ||
| * Find a changelog file in the package's root-level files. | ||
| * Returns the actual filename if found, null otherwise. | ||
| * | ||
| * @param files - The file tree from jsDelivr API (root-level files only) | ||
| * @returns The changelog filename if found, null otherwise | ||
| */ | ||
| export function findChangelogFile(files: JsDelivrFileNode[]): string | null { | ||
| // Create a map for case-insensitive lookup of actual filenames | ||
| const fileMap = new Map<string, string>() | ||
| for (const file of files) { | ||
| if (file.type === 'file') { | ||
| fileMap.set(file.name.toLowerCase(), file.name) | ||
| } | ||
| } | ||
|
|
||
| // Check for changelog files in priority order | ||
| for (const changelogName of CHANGELOG_FILENAMES) { | ||
| const actualName = fileMap.get(changelogName.toLowerCase()) | ||
| if (actualName) { | ||
| return actualName | ||
| } | ||
| } | ||
|
|
||
| return null | ||
| } |
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does tangled.sh have release pages? Do we have some better pattern for this or prior art?