feat(@142vip/changelog): 支持自定义版本名称

Author: mmdapl

packages/changelog/src/changelog.ts

@@ -61,7 +61,7 @@ cli
 
       // 更新changelog文档
       if (typeof config.output === 'string') {
-        await updateChangelog(config.output, markdown, config.to)
+        await updateChangelog(config.output, markdown, config.name)
         return
       }
 

packages/changelog/src/core/config.ts

@@ -44,10 +44,15 @@ export async function resolveConfig(options: ChangelogOptions) {
 
   config.baseUrl = config.baseUrl ?? 'github.com'
   config.baseUrlApi = config.baseUrlApi ?? 'api.github.com'
+  // 发布的版本
   config.to = config.to || await getCurrentGitBranch()
+  // release name
+  config.name = config.name ?? config.to
   config.from = config.from || await getLastMatchingTag(config.to) || await getFirstGitCommit()
   // @ts-expect-error backward compatibility
   config.repo = config.repo || config.github || await getGitHubRepo(config.baseUrl)
+
+  // 是否是预览版本
   config.prerelease = config.prerelease ?? isPrerelease(config.to)
 
   // todo 支持多个scope生成

packages/changelog/src/core/github.ts

@@ -81,7 +81,6 @@ export async function resolveAuthorInfo(options: ChangelogOptions, info: AuthorI
     catch {
     }
   }
-
   return info
 }
 

packages/changelog/src/core/markdown.ts

@@ -19,6 +19,8 @@ function formatReferences(references: Reference[], baseUrl: string, github: stri
         return ref.value
       if (ref.type === 'pull-request' || ref.type === 'issue')
         return `https://${baseUrl}/${github}/issues/${ref.value.slice(1)}`
+
+      // 截取前面5个字符
       return `[<samp>(${ref.value.slice(0, 5)})</samp>](https://${baseUrl}/${github}/commit/${ref.value})`
     })
 
@@ -34,10 +36,15 @@ function formatLine(commit: Commit, options: ResolvedChangelogOptions) {
   const hashRefs = formatReferences(commit.references, options.baseUrl, options.repo as string, 'hash')
 
   let authors = join([...new Set(commit.resolvedAuthors?.map(i => i.login ? `@${i.login}` : `**${i.name}**`))])?.trim()
+
   if (authors)
     authors = `by ${authors}`
 
-  let refs = [authors, prRefs, hashRefs].filter(i => i?.trim()).join(' ')
+  let refs = [
+    authors,
+    prRefs,
+    hashRefs,
+  ].filter(i => i?.trim()).join(' ')
 
   if (refs)
     refs = `&nbsp;-&nbsp; ${refs}`
@@ -127,9 +134,9 @@ export async function generateMarkdown(commits: Commit[], options: ResolvedChang
     lines.push('\n**No significant changes**')
   }
   else {
-    const url = `https://${options.baseUrl}/${options.repo}/compare/${options.from}...${options.to}`
+    const url = `https://${options.baseUrl}/${options.repo}/compare/${options.from}...${options.name}`
     // 添加版本
-    lines.push(`\n**Release New Version v${options.to} [👉 View changes on GitHub](${url})**`)
+    lines.push(`\n**Release New Version ${options.name} [👉 View Changes On GitHub](${url})**`)
   }
 
   return convert(lines.join('\n').trim(), true)
@@ -139,9 +146,9 @@ export async function generateMarkdown(commits: Commit[], options: ResolvedChang
  * 更新changelog
  * @param outputPath
  * @param markdown
- * @param to
+ * @param releaseVersionName
  */
-export async function updateChangelog(outputPath: string, markdown: string, to: string) {
+export async function updateChangelog(outputPath: string, markdown: string, releaseVersionName: string) {
   let changelogMD: string
   if (existsSync(outputPath)) {
     console.info(`Updating ${outputPath}`)
@@ -153,7 +160,7 @@ export async function updateChangelog(outputPath: string, markdown: string, to:
   }
 
   // 添加版本头部
-  const newMd = `## ${to} (${dayjs().format('YYYY-MM-DD')})\n\n${markdown}`
+  const newMd = `## ${releaseVersionName} (${dayjs().format('YYYY-MM-DD')})\n\n${markdown}`
 
   const lastEntry = changelogMD.match(/^##\s+(?:\S.*)?$/m)