release-it-gitea 1.6.0 → 1.7.0

package/README.md

@@ -57,19 +57,19 @@ npx release-it
 
 ### 基本配置选项
 
-| 选项           | 类型    | 默认值                 | 描述                 |
-| -------------- | ------- | ---------------------- | -------------------- |
-| `host`         | string  | 当前仓库的 host        | Gitea 服务器 URL     |
-| `owner`        | string  | 从 git remote 自动检测 | 仓库所有者           |
-| `repository`   | string  | 从 git remote 自动检测 | 仓库名称             |
-| `release`      | boolean | `true`                 | 是否创建发布         |
-| `releaseTitle` | string  | `"v${version}"`        | 发布标题模板         |
-| `releaseNotes` | string  | `"${changelog}"`       | 发布说明模板         |
-| `prerelease`   | boolean | `false`                | 是否为预发布         |
-| `draft`        | boolean | `false`                | 是否为草稿           |
-| `tokenRef`     | string  | `"GITEA_TOKEN"`        | API token 环境变量名 |
-| `timeout`      | number  | `30000`                | 请求超时时间（毫秒） |
-| `assets`       | array   | `[]`                   | 附加的资源文件       |
+| 选项           | 类型                          | 默认值                 | 描述                                               |
+| -------------- | ----------------------------- | ---------------------- | -------------------------------------------------- |
+| `host`         | string                        | 当前仓库的 host        | Gitea 服务器 URL                                   |
+| `owner`        | string                        | 从 git remote 自动检测 | 仓库所有者                                         |
+| `repository`   | string                        | 从 git remote 自动检测 | 仓库名称                                           |
+| `release`      | boolean                       | `true`                 | 是否创建发布                                       |
+| `releaseTitle` | string \| (context) => string | `"v${version}"`        | 发布标题模板，支持变量替换和函数回调               |
+| `releaseNotes` | string \| (context) => string | `"${changelog}"`       | 发布说明模板，支持变量替换、Markdown格式和函数回调 |
+| `prerelease`   | boolean                       | `false`                | 是否为预发布                                       |
+| `draft`        | boolean                       | `false`                | 是否为草稿                                         |
+| `tokenRef`     | string                        | `"GITEA_TOKEN"`        | API token 环境变量名                               |
+| `timeout`      | number                        | `30000`                | 请求超时时间（毫秒）                               |
+| `assets`       | array                         | `[]`                   | 附加的资源文件                                     |
 
 ### 完整配置示例
 
@@ -261,6 +261,147 @@ export MY_GITEA_TOKEN=your_gitea_api_token
 | `${repo.repository}` | 仓库名称     | `my-repo`            |
 | `${branchName}`      | 分支名称     | `main`               |
 
+### 函数回调配置
+
+在 JavaScript 配置文件中，可以为 `releaseTitle` 和 `releaseNotes` 传入函数回调，实现更灵活的配置：
+
+```js
+// .release-it.js
+module.exports = {
+	plugins: {
+		"release-it-gitea": {
+			host: "https://gitea.example.com",
+			owner: "your-username",
+			repository: "your-repo",
+			// 使用函数生成动态的发布标题
+			releaseTitle: (context) => {
+				const date = new Date().toISOString().split("T")[0];
+				return `🚀 ${context.name} v${context.version} (${date})`;
+			},
+			// 使用函数生成动态的发布说明
+			releaseNotes: (context) => {
+				const sections = context.changelog.split("\n## ");
+				const features = sections.find(
+					(s) => s.startsWith("Features") || s.startsWith("新特性"),
+				);
+				const fixes = sections.find(
+					(s) => s.startsWith("Bug Fixes") || s.startsWith("修复"),
+				);
+
+				return `## ${context.name} v${context.version} 发布说明
+        
+## ✨ 新特性
+${features ? "## " + features : "无"}
+
+## 🐛 问题修复
+${fixes ? "## " + fixes : "无"}
+
+## 📦 安装
+\`\`\`
+npm install ${context.name}@${context.version}
+\`\`\``;
+			},
+			// 其他配置...
+		},
+	},
+};
+```
+
+使用函数回调的优势：
+
+- 可以进行复杂的逻辑处理
+- 可以访问完整的 context 对象
+- 可以根据条件动态生成内容
+- 可以整合外部数据或API结果
+
+> **注意**: 函数回调仅在使用 JavaScript 配置文件 (如 `.release-it.js` 或 `.release-it.cjs`) 时可用，在 JSON 配置文件中只能使用字符串模板。
+
+### 使用 NPM 包
+
+`releaseTitle` 和 `releaseNotes` 还支持通过 `npm:` 前缀引用外部 NPM 包来生成内容：
+
+```json
+{
+	"plugins": {
+		"release-it-gitea": {
+			"releaseTitle": "npm:my-release-notes-generator",
+			"releaseNotes": "npm:my-changelog-formatter"
+		}
+	}
+}
+```
+
+使用 NPM 包的方式：
+
+1. 创建并发布一个 NPM 包，该包导出以下方法：
+
+   ```js
+   // my-release-notes-generator 包示例
+   module.exports = {
+   	releaseTitle: function (context) {
+   		return `Release v${context.version} - ${new Date().toLocaleDateString()}`;
+   	},
+   	releaseNotes: function (context) {
+   		// 自定义格式化逻辑
+   		return `# ${context.name} v${context.version}\n\n${context.changelog}`;
+   	},
+   };
+   ```
+
+2. 安装该包：
+
+   ```bash
+   npm install --save-dev my-release-notes-generator
+   ```
+
+3. 在配置中引用：
+   ```json
+   {
+   	"releaseTitle": "npm:my-release-notes-generator",
+   	"releaseNotes": "npm:my-release-notes-generator"
+   }
+   ```
+
+使用 NPM 包的优势：
+
+- 可以在多个项目间共享相同的发布标题和说明格式
+- 可以独立于项目维护和更新发布格式
+- 支持更复杂的逻辑和依赖
+- 可以在 JSON 配置中使用，不仅限于 JavaScript 配置
+
+### Context 对象属性
+
+在函数回调中，您可以访问以下 context 对象属性：
+
+| 属性              | 类型   | 描述                          | 示例值                           |
+| ----------------- | ------ | ----------------------------- | -------------------------------- |
+| `version`         | string | 当前版本号                    | `"1.2.3"`                        |
+| `latestVersion`   | string | 上一个版本号                  | `"1.2.2"`                        |
+| `changelog`       | string | 生成的变更日志内容            | `"## Bug Fixes\n\n* 修复..."`    |
+| `name`            | string | 项目名称                      | `"my-project"`                   |
+| `branchName`      | string | 当前分支名                    | `"main"`                         |
+| `releaseUrl`      | string | 发布 URL (仅在更新发布后可用) | `"https://gitea.com/.../v1.2.3"` |
+| `repo`            | object | 仓库相关信息                  |                                  |
+| `repo.host`       | string | 仓库主机地址                  | `"gitea.example.com"`            |
+| `repo.owner`      | string | 仓库所有者                    | `"username"`                     |
+| `repo.project`    | string | 项目名称                      | `"my-repo"`                      |
+| `repo.protocol`   | string | 仓库协议                      | `"https"`                        |
+| `repo.remote`     | string | 远程仓库名称                  | `"origin"`                       |
+| `repo.repository` | string | 仓库名称                      | `"my-repo"`                      |
+
+**示例：使用 context 属性生成自定义发布标题**
+
+```js
+releaseTitle: (context) => {
+	const emoji = context.version.includes("beta")
+		? "🧪"
+		: context.version.includes("alpha")
+			? "🚧"
+			: "🚀";
+	return `${emoji} ${context.name} v${context.version} [${context.branchName}]`;
+};
+```
+
 ### 模板使用示例
 
 ```json

package/lib/index.js

@@ -351,7 +351,21 @@ class GiteaPlugin extends Plugin {
   getReleaseNotes() {
     const releaseNotes = this.giteaConfig.releaseNotes;
     if (typeof releaseNotes === "string") {
-      return this.interpolate(releaseNotes);
+      if (releaseNotes.startsWith("npm:")) {
+        const npmPackage = releaseNotes.slice(4);
+        try {
+          const npmHandler = require(npmPackage);
+          if (typeof npmHandler !== "function") {
+            throw new Error(`${npmPackage} not found npm`);
+          }
+          return npmHandler.releaseNotes(this.config.getContext());
+        } catch (error) {
+          console.error(error);
+          throw new Error(`${npmPackage} not found npm`);
+        }
+      } else {
+        return this.interpolate(releaseNotes);
+      }
     } else if (typeof releaseNotes === "function") {
       return releaseNotes(this.config.getContext());
     }
@@ -360,7 +374,21 @@ class GiteaPlugin extends Plugin {
   getReleaseTitle() {
     const releaseTitle = this.giteaConfig.releaseTitle;
     if (typeof releaseTitle === "string") {
-      return this.interpolate(releaseTitle);
+      if (releaseTitle.startsWith("npm:")) {
+        const npmPackage = releaseTitle.slice(4);
+        try {
+          const npmHandler = require(npmPackage);
+          if (typeof npmHandler !== "function") {
+            throw new Error(`${npmPackage} not found npm`);
+          }
+          return npmHandler.releaseTitle(this.config.getContext());
+        } catch (error) {
+          console.error(error);
+          throw new Error(`${npmPackage} not found npm`);
+        }
+      } else {
+        return this.interpolate(releaseTitle);
+      }
     } else if (typeof releaseTitle === "function") {
       return releaseTitle(this.config.getContext());
     }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "release-it-gitea",
-	"version": "1.6.0",
+	"version": "1.7.0",
 	"description": "release-it gitea plugin",
 	"keywords": [
 		"gitea",