feat: common auto pr add link (#88)

liweijie0812 · web-flow · commit 77fccb8a45c2 · 2025-11-20T13:32:01.000+08:00
* feat: common auto pr add link

* ci: fix paths

* ci: fix paths

* chore: print diff
diff --git a/.github/workflows/test-tdesign-common-trigger.yaml b/.github/workflows/test-tdesign-common-trigger.yaml
@@ -3,7 +3,7 @@ on:
   pull_request:
     branches: [develop]
     paths:
-      - dist/index.js
+      - dist/*
 
 jobs:
   pr-vue:
diff --git a/.github/workflows/test-tdesign-icons-trigger.yaml b/.github/workflows/test-tdesign-icons-trigger.yaml
@@ -3,7 +3,7 @@ on:
   pull_request:
     branches: [develop]
     paths:
-      - dist/index.js
+      - dist/*
 
 jobs:
   pr-vue:
diff --git a/.github/workflows/test-upgrade-deps-trigger.yml b/.github/workflows/test-upgrade-deps-trigger.yml
@@ -3,7 +3,7 @@ on:
   pull_request:
     branches: [develop]
     paths:
-      - dist/index.js
+      - dist/*
 
 jobs:
   upgrade-deps:
diff --git a/dist/index.mjs b/dist/index.mjs
@@ -43750,7 +43750,7 @@ var import_lib = require_lib();
 var import_lib$1 = require_lib$3();
 const SKIP_CHANGELOG_REG = /\[x\] 本条 PR 不需要纳入 Changelog/i;
 const CHANGELOG_REG = /-\s([A-Z]+)(?:\(([A-Z\s_-]*)\))?\s*:\s*(.+)/i;
-function addContributor(body, contributor) {
+function addContributor(body, contributor, link) {
 	if (SKIP_CHANGELOG_REG.test(body)) {
 		(0, import_core$6.info)(`不需要纳入 Changelog`);
 		return body;
@@ -43767,7 +43767,11 @@ function addContributor(body, contributor) {
 				isSkip = true;
 				return item;
 			}
-			if (CHANGELOG_REG.test(item)) return `${item} @${contributor}`;
+			if (CHANGELOG_REG.test(item)) {
+				let logContent = `${item} @${contributor}`;
+				if (link) logContent += ` ${link}`;
+				return logContent;
+			}
 		}
 		if (item === "### 📝 更新日志") isSkip = false;
 		return item;
@@ -43930,6 +43934,9 @@ var GitHelper = class {
 		const { stdout } = await (0, import_exec$3.getExecOutput)("git", ["status"], { cwd: this.repoPath });
 		return !stdout.includes("nothing to commit, working tree clean");
 	}
+	async printDiff() {
+		await (0, import_exec$3.exec)("git", ["diff"], { cwd: this.repoPath });
+	}
 };
 
 //#endregion
@@ -44028,7 +44035,8 @@ async function start(context$1) {
 		githubHelper.addComment(context$1.pr_number, "PR 还没合并，无法触发");
 		return;
 	}
-	const body = addContributor(prData.body || "", prData.user.login);
+	const link = `([common#${context$1.pr_number}](https://github.com/Tencent/tdesign-common/pull/${context$1.pr_number}))`;
+	const body = addContributor(prData.body || "", prData.user.login, link);
 	const trigger = context$1.trigger;
 	const gitHelper = new GitHelper({
 		repo: repoMap[trigger],
@@ -44055,7 +44063,10 @@ async function start(context$1) {
 			"--NAME",
 			"all"
 		], { cwd: `./${repoMap[trigger]}` });
-		if (await gitHelper.isNeedCommit()) await gitHelper.commit("docs: update css vars");
+		if (await gitHelper.isNeedCommit()) {
+			await gitHelper.printDiff();
+			await gitHelper.commit("docs: update css vars");
+		}
 	}
 	await gitHelper.push(branchName);
 	const newPrData = await new GithubHelper({
diff --git a/src/tdesign/common.ts b/src/tdesign/common.ts
@@ -22,7 +22,8 @@ export default async function start(context: TriggerContext) {
     githubHelper.addComment(context.pr_number, 'PR 还没合并，无法触发')
     return
   }
-  const body = addContributor(prData.body || '', prData.user.login)
+  const link = `([common#${context.pr_number}](https://github.com/Tencent/tdesign-common/pull/${context.pr_number}))`
+  const body = addContributor(prData.body || '', prData.user.login, link)
   const trigger = context.trigger as AutoPrTrigger
   const gitHelper = new GitHelper({
     repo: repoMap[trigger],
@@ -51,6 +52,7 @@ export default async function start(context: TriggerContext) {
     }
     await exec('node', [scriptPath, '--NAME', 'all'], { cwd: `./${repoMap[trigger]}` })
     if (await gitHelper.isNeedCommit()) {
+      await gitHelper.printDiff()
       await gitHelper.commit('docs: update css vars')
     }
   }
diff --git a/src/utils/common.ts b/src/utils/common.ts
@@ -8,7 +8,7 @@ import { readWorkspaceManifest } from '@pnpm/workspace.read-manifest'
 
 export const SKIP_CHANGELOG_REG = /\[x\] 本条 PR 不需要纳入 Changelog/i
 export const CHANGELOG_REG = /-\s([A-Z]+)(?:\(([A-Z\s_-]*)\))?\s*:\s*(.+)/i
-export function addContributor(body: string, contributor: string): string {
+export function addContributor(body: string, contributor: string, link?: string): string {
   if (SKIP_CHANGELOG_REG.test(body)) {
     info(`不需要纳入 Changelog`)
     return body
@@ -26,7 +26,12 @@ export function addContributor(body: string, contributor: string): string {
       }
       if (CHANGELOG_REG.test(item)) {
         // info(`匹配到更新日志项: ${item}`)
-        return `${item} @${contributor}`
+        let logContent = `${item} @${contributor}`
+        if (link) {
+          logContent += ` ${link}`
+        }
+
+        return logContent
       }
     }
     if (item === '### 📝 更新日志') {
diff --git a/src/utils/git-helper.ts b/src/utils/git-helper.ts
@@ -71,4 +71,8 @@ export class GitHelper {
     const { stdout } = await getExecOutput('git', ['status'], { cwd: this.repoPath })
     return !stdout.includes('nothing to commit, working tree clean')
   }
+
+  async printDiff() {
+    await exec('git', ['diff'], { cwd: this.repoPath })
+  }
 }
diff --git a/test/__snapshots__/utils.test.ts.snap b/test/__snapshots__/utils.test.ts.snap
@@ -1,6 +1,6 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
-exports[`utils > addContributor > one log 1`] = `
+exports[`utils > addContributor > no link log 1`] = `
 "<!--
 首先，感谢你的贡献！😄
 请阅读并遵循 [TDesign 贡献指南](https://github.com/Tencent/tdesign/blob/main/docs/contributing.md)，填写以下 pull request 的信息。
@@ -58,6 +58,64 @@ from https://github.com/Tencent/tdesign-vue-next/issues/4866
 "
 `;
 
+exports[`utils > addContributor > one log 1`] = `
+"<!--
+首先，感谢你的贡献！😄
+请阅读并遵循 [TDesign 贡献指南](https://github.com/Tencent/tdesign/blob/main/docs/contributing.md)，填写以下 pull request 的信息。
+PR 在维护者审核通过后会合并，谢谢！
+-->
+
+### 🤔 这个 PR 的性质是？
+
+- [x] 日常 bug 修复
+- [ ] 新特性提交
+- [ ] 文档改进
+- [ ] 演示代码改进
+- [ ] 组件样式/交互改进
+- [ ] CI/CD 改进
+- [ ] 重构
+- [ ] 代码风格优化
+- [ ] 测试用例
+- [ ] 分支合并
+- [ ] 其他
+
+### 🔗 相关 Issue
+
+<!--
+1. 描述相关需求的来源，如相关的 issue 讨论链接。
+-->
+
+from https://github.com/Tencent/tdesign-vue-next/issues/4866
+
+### 💡 需求背景和解决方案
+
+<!--
+1. 要解决的具体问题。
+2. 列出最终的 API 实现和用法。
+3. 涉及UI/交互变动需要有截图或 GIF。
+-->
+
+### 📝 更新日志
+
+<!--
+从用户角度描述具体变化，以及可能的 breaking change 和其他风险。
+-->
+
+- fix(Utils): 修复日志一条 @tdesign-helper ([common#2283](https://github.com/Tencent/tdesign-common/pull/2283))
+
+- [ ] 本条 PR 不需要纳入 Changelog
+
+### ☑️ 请求合并前的自查清单
+
+⚠️ 请自检并全部**勾选全部选项**。⚠️
+
+- [x] 文档已补充或无须补充
+- [x] 代码演示已提供或无须提供
+- [x] TypeScript 定义已补充或无须补充
+- [x] Changelog 已提供或无须提供
+"
+`;
+
 exports[`utils > addContributor > skip log 1`] = `
 "<!--
 首先，感谢你的贡献！😄
@@ -159,8 +217,8 @@ from https://github.com/Tencent/tdesign-vue-next/issues/4866
 从用户角度描述具体变化，以及可能的 breaking change 和其他风险。
 -->
 
-- chore: 第一条日志 @tdesign-helper
-- chore: 第二条日志 @tdesign-helper
+- chore: 第一条日志 @tdesign-helper ([common#2283](https://github.com/Tencent/tdesign-common/pull/2283))
+- chore: 第二条日志 @tdesign-helper ([common#2283](https://github.com/Tencent/tdesign-common/pull/2283))
 
 - [ ] 本条 PR 不需要纳入 Changelog
 
diff --git a/test/utils.test.ts b/test/utils.test.ts
@@ -6,13 +6,20 @@ describe('utils', () => {
   describe('addContributor', () => {
     it('one log', () => {
       const pr_body = readFileSync('test/fixtures/pr_body.md', 'utf8').replaceAll('\n', '\r\n')
-
-      const body = addContributor(pr_body, 'tdesign-helper')
+      const link = `([common#2283](https://github.com/Tencent/tdesign-common/pull/2283))`
+      const body = addContributor(pr_body, 'tdesign-helper', link)
       expect(body).toMatchSnapshot()
     })
 
     it('two log', () => {
       const pr_body = readFileSync('test/fixtures/pr_body_two_log.md', 'utf8').replaceAll('\n', '\r\n')
+      const link = `([common#2283](https://github.com/Tencent/tdesign-common/pull/2283))`
+      const body = addContributor(pr_body, 'tdesign-helper', link)
+      expect(body).toMatchSnapshot()
+    })
+
+    it('no link log', () => {
+      const pr_body = readFileSync('test/fixtures/pr_body.md', 'utf8').replaceAll('\n', '\r\n')
       const body = addContributor(pr_body, 'tdesign-helper')
       expect(body).toMatchSnapshot()
     })

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,8 @@ export default async function start(context: TriggerContext) {`
`22`	`22`	`githubHelper.addComment(context.pr_number, 'PR 还没合并，无法触发')`
`23`	`23`	`return`
`24`	`24`	`}`
`25`		`- const body = addContributor(prData.body \|\| '', prData.user.login)`
	`25`	+ const link = `([common#${context.pr_number}](https://github.com/Tencent/tdesign-common/pull/${context.pr_number}))`
	`26`	`+ const body = addContributor(prData.body \|\| '', prData.user.login, link)`
`26`	`27`	`const trigger = context.trigger as AutoPrTrigger`
`27`	`28`	`const gitHelper = new GitHelper({`
`28`	`29`	`repo: repoMap[trigger],`
`@@ -51,6 +52,7 @@ export default async function start(context: TriggerContext) {`
`51`	`52`	`}`
`52`	`53`	await exec('node', [scriptPath, '--NAME', 'all'], { cwd: `./${repoMap[trigger]}` })
`53`	`54`	`if (await gitHelper.isNeedCommit()) {`
	`55`	`+ await gitHelper.printDiff()`
`54`	`56`	`await gitHelper.commit('docs: update css vars')`
`55`	`57`	`}`
`56`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -71,4 +71,8 @@ export class GitHelper {`
`71`	`71`	`const { stdout } = await getExecOutput('git', ['status'], { cwd: this.repoPath })`
`72`	`72`	`return !stdout.includes('nothing to commit, working tree clean')`
`73`	`73`	`}`
	`74`	`+`
	`75`	`+ async printDiff() {`
	`76`	`+ await exec('git', ['diff'], { cwd: this.repoPath })`
	`77`	`+ }`
`74`	`78`	`}`