release-it-gitea 1.3.2 → 1.4.0

package/README.md

@@ -1,16 +1,15 @@
-# release-it-gitea
+# Release It! Gitea Plugin
 
-一个用于 [release-it](https://github.com/release-it/release-it) 的 Gitea 插件，可以在生成版本和 changelog 后自动将它们推送到指定的 Gitea 服务器的仓库发布中。
+一个用于 [release-it](https://github.com/release-it/release-it) 的 Gitea 插件，支持自动创建 Gitea 发布并上传附件。
 
 ## 功能特性
 
-- ✅ 自动创建 Gitea 发布
-- ✅ 支持自定义发布标题和说明
-- ✅ 支持预发布和草稿发布
-- ✅ 支持模板变量替换
-- ✅ 自动检测并更新已存在的发布
-- ✅ 完整的错误处理和日志记录
-- ✅ TypeScript 支持
+- ✅ 自动创建和更新 Gitea 发布
+- ✅ 支持模板变量替换（版本号、变更日志等）
+- ✅ 支持草稿和预发布版本
+- ✅ **新功能：支持文件和文件夹附件上传**
+- ✅ **新功能：支持自动打包文件夹为 ZIP**
+- ✅ **新功能：支持通配符文件匹配**
 
 ## 安装
 
@@ -47,7 +46,8 @@ export GITEA_TOKEN="your-gitea-api-token"
 			"releaseTitle": "v${version}",
 			"releaseNotes": "${changelog}",
 			"prerelease": false,
-			"draft": false
+			"draft": false,
+			"tokenRef": "GITEA_TOKEN"
 		}
 	}
 }
@@ -72,95 +72,226 @@ export GITEA_TOKEN="your-gitea-api-token"
 
 ## 配置选项
 
-| 选项           | 类型      | 默认值                 | 描述                 |
-| -------------- | --------- | ---------------------- | -------------------- |
-| `host`         | `string`  | **必需**               | 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`                | 请求超时时间（毫秒） |
-
-## 模板变量
-
-在 `releaseTitle` 和 `releaseNotes` 中可以使用以下模板变量：
-
-- `${version}` - 当前版本号
-- `${latestVersion}` - 上一个版本号
-- `${changelog}` - 生成的 changelog
-- `${name}` - 项目名称
-- `${repo.owner}` - 仓库所有者
-- `${repo.repository}` - 仓库名称
-- `${branchName}` - 当前分支名
+| 选项           | 类型                   | 默认值                 | 描述                 |
+| -------------- | ---------------------- | ---------------------- | -------------------- |
+| `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`       | `(string \| object)[]` | ``                     | 附加的资源文件       |
 
-## 使用示例
+## 附件上传配置
 
-### 基础配置
+### 基本附件配置
 
 ```json
 {
 	"plugins": {
 		"release-it-gitea": {
-			"host": "https://gitea.example.com"
+			"host": "https://gitea.example.com",
+			"owner": "your-username",
+			"repository": "your-repo",
+			"assets": ["dist/app.js", "README.md", "dist/**/*.min.js"]
 		}
 	}
 }
 ```
 
-### 完整配置
+### 高级附件配置
 
 ```json
 {
 	"plugins": {
 		"release-it-gitea": {
 			"host": "https://gitea.example.com",
-			"owner": "myorg",
-			"repository": "myproject",
-			"release": true,
-			"releaseTitle": "Release ${version}",
-			"releaseNotes": "## 更新内容\n\n${changelog}\n\n---\n\n完整更新日志请查看 [CHANGELOG.md](./CHANGELOG.md)",
-			"prerelease": false,
-			"draft": false,
-			"tokenRef": "GITEA_TOKEN",
-			"timeout": 30000
+			"owner": "your-username",
+			"repository": "your-repo",
+			"assets": [
+				{
+					"path": "dist/**/*",
+					"name": "distribution-files.zip",
+					"type": "zip",
+					"label": "Distribution Files"
+				},
+				{
+					"path": "docs/*.md",
+					"type": "file",
+					"label": "Documentation"
+				},
+				{
+					"path": "src",
+					"name": "source-code.zip",
+					"type": "zip",
+					"label": "Source Code"
+				}
+			]
 		}
 	}
 }
 ```
 
-### 预发布配置
+## 附件配置选项
+
+### 字符串格式
+
+直接指定文件路径，支持通配符：
+
+```json
+"assets": [
+	"dist/app.js",
+	"build/**/*.min.js",
+	"*.md"
+]
+```
+
+### 对象格式
+
+更详细的配置选项：
+
+| 属性    | 类型            | 必需 | 描述                                 |
+| ------- | --------------- | ---- | ------------------------------------ |
+| `path`  | string          | ✅   | 文件或文件夹路径，支持通配符         |
+| `name`  | string          | ❌   | 上传后的文件名，不指定则使用原文件名 |
+| `type`  | 'file' \| 'zip' | ❌   | 文件类型，默认为 'file'              |
+| `label` | string          | ❌   | 文件标签，用于标识文件用途           |
+
+### 文件类型说明
+
+- **`file`**: 直接上传匹配到的文件
+- **`zip`**: 将匹配到的文件打包成 ZIP 文件后上传
+
+## 使用示例
+
+### 示例 1：上传构建产物
 
 ```json
 {
-	"plugins": {
-		"release-it-gitea": {
-			"host": "https://gitea.example.com",
-			"releaseTitle": "v${version} (预发布)",
-			"prerelease": true
+	"assets": ["dist/bundle.js", "dist/bundle.css", "dist/assets/**/*"]
+}
+```
+
+### 示例 2：打包源代码
+
+```json
+{
+	"assets": [
+		{
+			"path": "src/**/*",
+			"name": "source-v${version}.zip",
+			"type": "zip",
+			"label": "Source Code"
 		}
-	}
+	]
 }
 ```
 
-## 工作流程
+### 示例 3：多种文件类型
 
-1. **初始化阶段** - 验证配置和 API 连接
-2. **发布阶段** - 创建或更新 Gitea 发布
-3. **发布后阶段** - 显示发布链接
+```json
+{
+	"assets": [
+		"README.md",
+		"CHANGELOG.md",
+		{
+			"path": "dist",
+			"name": "build-output.zip",
+			"type": "zip"
+		},
+		{
+			"path": "docs/**/*.pdf",
+			"type": "file",
+			"label": "Documentation"
+		}
+	]
+}
+```
+
+## 完整配置选项
+
+| 选项           | 类型    | 默认值           | 描述                 |
+| -------------- | ------- | ---------------- | -------------------- |
+| `host`         | string  | -                | Gitea 服务器地址     |
+| `owner`        | string  | -                | 仓库所有者           |
+| `repository`   | string  | -                | 仓库名称             |
+| `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   | `[]`             | 附件配置列表         |
+
+## 环境变量
+
+设置 Gitea API Token：
+
+```bash
+export GITEA_TOKEN=your_gitea_api_token
+```
+
+或者使用自定义环境变量名：
+
+```json
+{
+	"tokenRef": "MY_GITEA_TOKEN"
+}
+```
 
-## 错误处理
+```bash
+export MY_GITEA_TOKEN=your_gitea_api_token
+```
+
+## 模板变量
+
+在 `releaseTitle` 和 `releaseNotes` 中可以使用以下变量：
+
+- `${version}`: 当前版本号
+- `${latestVersion}`: 上一个版本号
+- `${changelog}`: 变更日志
+- `${name}`: 项目名称
+- `${repo.owner}`: 仓库所有者
+- `${repo.repository}`: 仓库名称
+- `${branchName}`: 分支名称
+
+## 故障排除
+
+### 常见问题
+
+1. **附件上传失败**
 
-插件包含完整的错误处理：
+   - 检查文件路径是否正确
+   - 确保文件存在且可读
+   - 检查 Gitea API Token 权限
 
-- 配置验证
-- API token 验证
-- 网络连接检查
-- API 请求错误处理
-- 详细的错误日志
+2. **ZIP 文件创建失败**
+
+   - 确保有足够的磁盘空间
+   - 检查临时目录权限
+
+3. **通配符匹配无文件**
+
+   - 验证通配符模式是否正确
+   - 检查当前工作目录
+
+4. **API 请求失败**
+   - 检查 Gitea 服务器地址是否正确
+   - 验证 API Token 是否有效
+   - 确认仓库所有者和名称正确
+
+### 调试模式
+
+使用 `--verbose` 参数查看详细日志：
+
+```bash
+npx release-it --verbose
+```
 
 ## 开发
 

package/lib/global.d.d.ts

@@ -54,6 +54,21 @@ declare module "release-it" {
 	}
 }
 
+/** 附件配置接口 */
+interface GiteaAssetConfig {
+	/** 文件或文件夹路径，支持通配符 */
+	path: string;
+
+	/** 上传后的文件名，如果不指定则使用原文件名 */
+	name?: string;
+
+	/** 文件类型：'file' 表示单个文件，'zip' 表示打包成 zip 文件 */
+	type?: "file" | "zip";
+
+	/** 文件标签，用于标识文件用途 */
+	label?: string;
+}
+
 interface GiteaConfig {
 	/** Gitea 服务器的完整 URL 地址 */
 	host: string;
@@ -84,4 +99,7 @@ interface GiteaConfig {
 
 	/** API 请求的超时时间，单位为毫秒 */
 	timeout?: number;
+
+	/** 要上传的附件列表 */
+	assets?: (GiteaAssetConfig | string)[];
 }

package/lib/index.d.ts

@@ -58,6 +58,46 @@ declare class GiteaPlugin extends Plugin {
      * @returns 替换变量后的字符串
      */
     private interpolate;
+    /**
+     * 解析附件配置，将字符串格式转换为标准配置对象
+     * @param asset 附件配置
+     * @returns 标准化的附件配置对象
+     */
+    private normalizeAssetConfig;
+    /**
+     * 根据路径模式匹配文件
+     * @param pattern 文件路径模式，支持通配符
+     * @returns 匹配到的文件路径数组
+     */
+    private resolveFiles;
+    /**
+     * 创建 ZIP 压缩包
+     * @param files 要压缩的文件列表
+     * @param outputPath 输出的 ZIP 文件路径
+     * @param basePath 基础路径，用于确定文件在压缩包中的相对路径
+     * @returns Promise<void>
+     */
+    private createZipArchive;
+    /**
+     * 上传单个附件到 Gitea 发布
+     * @param releaseId 发布 ID
+     * @param filePath 文件路径
+     * @param fileName 上传后的文件名
+     * @param label 文件标签
+     * @returns 上传结果
+     */
+    private uploadAsset;
+    /**
+     * 处理并上传所有配置的附件
+     * @param releaseId 发布 ID
+     */
+    private uploadAssets;
+    /**
+     * 处理单个附件配置
+     * @param releaseId 发布 ID
+     * @param config 附件配置
+     */
+    private processAsset;
     /**
      * 执行发布操作，创建或更新 Gitea 发布.
      * @throws 当发布创建失败时抛出错误

package/lib/index.js

@@ -1,4 +1,9 @@
+import archiver from "archiver";
+import FormData from "form-data";
+import { createReadStream, createWriteStream, statSync } from "fs";
+import { glob } from "glob";
 import fetch from "node-fetch";
+import { basename, dirname, join } from "path";
 import { Plugin } from "release-it";
 class GiteaPlugin extends Plugin {
   static isEnabled(config) {
@@ -17,13 +22,13 @@ class GiteaPlugin extends Plugin {
     const repo = this.config.getContext("repo");
     const config = {
       draft: gitea.draft ?? false,
-      host: gitea.host,
+      host: gitea.host ?? repo.host,
       owner: gitea.owner ?? repo.owner,
       prerelease: gitea.prerelease ?? false,
       release: gitea.release !== false,
       releaseNotes: gitea.releaseNotes ?? "${changelog}",
       releaseTitle: gitea.releaseTitle ?? "v${version}",
-      repository: gitea.repository ?? repo.repository,
+      repository: gitea.repository ?? repo.project,
       timeout: gitea.timeout ?? 3e4,
       tokenRef: gitea.tokenRef ?? "GITEA_TOKEN"
     };
@@ -60,7 +65,10 @@ class GiteaPlugin extends Plugin {
    * @returns 完整的 API URL
    */
   buildApiUrl(endpoint) {
-    const host = this.giteaConfig.host.replace(/\/$/, "");
+    let host = this.giteaConfig.host.replace(/\/$/, "");
+    if (!host.startsWith("http")) {
+      host = `https://${host}`;
+    }
     return `${host}/api/v1${endpoint}`;
   }
   /**
@@ -159,6 +167,177 @@ class GiteaPlugin extends Plugin {
     const context = this.config.getContext();
     return template.replace(/\$\{version\}/g, context.version).replace(/\$\{latestVersion\}/g, context.latestVersion).replace(/\$\{changelog\}/g, context.changelog).replace(/\$\{name\}/g, context.name).replace(/\$\{repo\.owner\}/g, context.repo.owner).replace(/\$\{repo\.repository\}/g, context.repo.repository).replace(/\$\{branchName\}/g, context.branchName);
   }
+  /**
+   * 解析附件配置，将字符串格式转换为标准配置对象
+   * @param asset 附件配置
+   * @returns 标准化的附件配置对象
+   */
+  normalizeAssetConfig(asset) {
+    if (typeof asset === "string") {
+      return {
+        path: asset,
+        type: "file"
+      };
+    }
+    return {
+      type: "file",
+      ...asset
+    };
+  }
+  /**
+   * 根据路径模式匹配文件
+   * @param pattern 文件路径模式，支持通配符
+   * @returns 匹配到的文件路径数组
+   */
+  async resolveFiles(pattern) {
+    try {
+      const files = await glob(pattern, {
+        absolute: true,
+        nodir: true
+      });
+      return files;
+    } catch (error) {
+      this.log.warn(`\u6587\u4EF6\u5339\u914D\u5931\u8D25: ${pattern}, \u9519\u8BEF: ${error}`);
+      return [];
+    }
+  }
+  /**
+   * 创建 ZIP 压缩包
+   * @param files 要压缩的文件列表
+   * @param outputPath 输出的 ZIP 文件路径
+   * @param basePath 基础路径，用于确定文件在压缩包中的相对路径
+   * @returns Promise<void>
+   */
+  async createZipArchive(files, outputPath, basePath) {
+    return new Promise((resolve, reject) => {
+      const output = createWriteStream(outputPath);
+      const archive = archiver("zip", {
+        zlib: { level: 9 }
+      });
+      output.on("close", () => {
+        this.log.verbose(
+          `ZIP \u6587\u4EF6\u521B\u5EFA\u5B8C\u6210: ${outputPath} (${archive.pointer()} bytes)`
+        );
+        resolve();
+      });
+      archive.on("error", (err) => {
+        reject(err);
+      });
+      archive.pipe(output);
+      for (const file of files) {
+        const stats = statSync(file);
+        if (stats.isFile()) {
+          const relativePath = basePath ? file.replace(basePath, "").replace(/^\//, "") : basename(file);
+          archive.file(file, { name: relativePath });
+        }
+      }
+      archive.finalize();
+    });
+  }
+  /**
+   * 上传单个附件到 Gitea 发布
+   * @param releaseId 发布 ID
+   * @param filePath 文件路径
+   * @param fileName 上传后的文件名
+   * @param label 文件标签
+   * @returns 上传结果
+   */
+  async uploadAsset(releaseId, filePath, fileName, label) {
+    const url = this.buildApiUrl(
+      `/repos/${this.giteaConfig.owner}/${this.giteaConfig.repository}/releases/${releaseId}/assets`
+    );
+    const token = this.getToken();
+    const form = new FormData();
+    form.append("attachment", createReadStream(filePath), {
+      contentType: "application/octet-stream",
+      filename: fileName
+    });
+    if (label) {
+      form.append("name", label);
+    }
+    const requestOptions = {
+      body: form,
+      headers: {
+        ...form.getHeaders(),
+        Authorization: `token ${token}`
+      },
+      method: "POST",
+      timeout: this.giteaConfig.timeout
+    };
+    this.log.verbose(`\u4E0A\u4F20\u9644\u4EF6: ${fileName} \u5230\u53D1\u5E03 ${releaseId}`);
+    try {
+      const response = await fetch(url, requestOptions);
+      if (!response.ok) {
+        const errorText = await response.text();
+        throw new Error(`\u9644\u4EF6\u4E0A\u4F20\u5931\u8D25 (${response.status}): ${errorText}`);
+      }
+      const result = await response.json();
+      this.log.info(`\u2705 \u9644\u4EF6\u4E0A\u4F20\u6210\u529F: ${fileName}`);
+      return result;
+    } catch (error) {
+      if (error instanceof Error) {
+        throw new Error(`\u9644\u4EF6\u4E0A\u4F20\u5931\u8D25: ${error.message}`);
+      }
+      throw error;
+    }
+  }
+  /**
+   * 处理并上传所有配置的附件
+   * @param releaseId 发布 ID
+   */
+  async uploadAssets(releaseId) {
+    const assets = this.giteaConfig.assets;
+    if (!assets || assets.length === 0) {
+      this.log.verbose("\u6CA1\u6709\u914D\u7F6E\u9644\u4EF6\uFF0C\u8DF3\u8FC7\u4E0A\u4F20");
+      return;
+    }
+    this.log.info(`\u5F00\u59CB\u4E0A\u4F20 ${assets.length} \u4E2A\u9644\u4EF6...`);
+    for (const asset of assets) {
+      try {
+        const config = this.normalizeAssetConfig(asset);
+        await this.processAsset(releaseId, config);
+      } catch (error) {
+        this.log.error(
+          `\u9644\u4EF6\u5904\u7406\u5931\u8D25: ${JSON.stringify(asset)}, \u9519\u8BEF: ${error}`
+        );
+      }
+    }
+    this.log.info("\u2705 \u6240\u6709\u9644\u4EF6\u5904\u7406\u5B8C\u6210");
+  }
+  /**
+   * 处理单个附件配置
+   * @param releaseId 发布 ID
+   * @param config 附件配置
+   */
+  async processAsset(releaseId, config) {
+    const files = await this.resolveFiles(config.path);
+    if (files.length === 0) {
+      this.log.warn(`\u6CA1\u6709\u627E\u5230\u5339\u914D\u7684\u6587\u4EF6: ${config.path}`);
+      return;
+    }
+    if (config.type === "zip") {
+      const zipName = config.name || `${basename(config.path)}.zip`;
+      const tempZipPath = join(process.cwd(), ".temp", zipName);
+      const { mkdirSync } = await import("fs");
+      try {
+        mkdirSync(dirname(tempZipPath), { recursive: true });
+      } catch (error) {
+      }
+      await this.createZipArchive(files, tempZipPath, dirname(config.path));
+      await this.uploadAsset(releaseId, tempZipPath, zipName, config.label);
+      const { unlinkSync } = await import("fs");
+      try {
+        unlinkSync(tempZipPath);
+      } catch (error) {
+        this.log.warn(`\u6E05\u7406\u4E34\u65F6\u6587\u4EF6\u5931\u8D25: ${tempZipPath}`);
+      }
+    } else {
+      for (const file of files) {
+        const fileName = config.name || basename(file);
+        await this.uploadAsset(releaseId, file, fileName, config.label);
+      }
+    }
+  }
   /**
    * 执行发布操作，创建或更新 Gitea 发布.
    * @throws 当发布创建失败时抛出错误
@@ -194,6 +373,9 @@ class GiteaPlugin extends Plugin {
         release = await this.createRelease(releaseData);
       }
       this.log.info(`\u2705 Gitea \u53D1\u5E03\u521B\u5EFA\u6210\u529F: ${release.html_url}`);
+      if (this.giteaConfig.assets && this.giteaConfig.assets.length > 0) {
+        await this.uploadAssets(release.id);
+      }
       this.config.setContext("releaseUrl", release.html_url);
     } catch (error) {
       if (error instanceof Error) {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "release-it-gitea",
-	"version": "1.3.2",
+	"version": "1.4.0",
 	"description": "release-it gitea plugin",
 	"keywords": [
 		"gitea",
@@ -44,12 +44,16 @@
 		"*": "prettier --ignore-unknown --write"
 	},
 	"dependencies": {
+		"archiver": "^7.0.1",
+		"form-data": "^4.0.3",
+		"glob": "^11.0.3",
 		"node-fetch": "^3.3.2"
 	},
 	"devDependencies": {
 		"@eslint-community/eslint-plugin-eslint-comments": "4.5.0",
 		"@eslint/js": "9.22.0",
 		"@release-it/conventional-changelog": "10.0.0",
+		"@types/archiver": "^6.0.3",
 		"@types/eslint-plugin-markdown": "2.0.2",
 		"@types/node": "22.13.10",
 		"@types/node-fetch": "^2.6.11",