release-it-gitea 1.1.0

package/LICENSE.md

@@ -0,0 +1,20 @@
+# MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,191 @@
+# release-it-gitea
+
+一个用于 [release-it](https://github.com/release-it/release-it) 的 Gitea 插件，可以在生成版本和 changelog 后自动将它们推送到指定的 Gitea 服务器的仓库发布中。
+
+## 功能特性
+
+- ✅ 自动创建 Gitea 发布
+- ✅ 支持自定义发布标题和说明
+- ✅ 支持预发布和草稿发布
+- ✅ 支持模板变量替换
+- ✅ 自动检测并更新已存在的发布
+- ✅ 完整的错误处理和日志记录
+- ✅ TypeScript 支持
+
+## 安装
+
+```bash
+npm install --save-dev release-it-gitea
+# 或
+pnpm add -D release-it-gitea
+# 或
+yarn add -D release-it-gitea
+```
+
+## 配置
+
+### 1. 设置环境变量
+
+首先，你需要设置 Gitea API token：
+
+```bash
+export GITEA_TOKEN="your-gitea-api-token"
+```
+
+### 2. 配置 release-it
+
+在你的 `.release-it.json` 文件中添加插件配置：
+
+```json
+{
+	"plugins": {
+		"release-it-gitea": {
+			"host": "https://gitea.example.com",
+			"owner": "your-username",
+			"repository": "your-repo",
+			"release": true,
+			"releaseTitle": "v${version}",
+			"releaseNotes": "${changelog}",
+			"prerelease": false,
+			"draft": false
+		}
+	}
+}
+```
+
+或者在 `package.json` 中：
+
+```json
+{
+	"release-it": {
+		"plugins": {
+			"release-it-gitea": {
+				"host": "https://gitea.example.com",
+				"owner": "your-username",
+				"repository": "your-repo",
+				"release": true
+			}
+		}
+	}
+}
+```
+
+## 配置选项
+
+| 选项           | 类型      | 默认值                 | 描述                 |
+| -------------- | --------- | ---------------------- | -------------------- |
+| `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}` - 当前分支名
+
+## 使用示例
+
+### 基础配置
+
+```json
+{
+	"plugins": {
+		"release-it-gitea": {
+			"host": "https://gitea.example.com"
+		}
+	}
+}
+```
+
+### 完整配置
+
+```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
+		}
+	}
+}
+```
+
+### 预发布配置
+
+```json
+{
+	"plugins": {
+		"release-it-gitea": {
+			"host": "https://gitea.example.com",
+			"releaseTitle": "v${version} (预发布)",
+			"prerelease": true
+		}
+	}
+}
+```
+
+## 工作流程
+
+1. **初始化阶段** - 验证配置和 API 连接
+2. **发布阶段** - 创建或更新 Gitea 发布
+3. **发布后阶段** - 显示发布链接
+
+## 错误处理
+
+插件包含完整的错误处理：
+
+- 配置验证
+- API token 验证
+- 网络连接检查
+- API 请求错误处理
+- 详细的错误日志
+
+## 开发
+
+```bash
+# 克隆仓库
+git clone https://github.com/lib-pack/release-it-gitea.git
+cd release-it-gitea
+
+# 安装依赖
+pnpm install
+
+# 构建
+pnpm build
+
+# 运行测试
+pnpm test
+
+# 代码检查
+pnpm lint
+```
+
+## 许可证
+
+MIT
+
+## 贡献
+
+欢迎提交 Issue 和 Pull Request！

package/lib/global.d.d.ts

@@ -0,0 +1,86 @@
+declare module "release-it" {
+	interface Config {
+		gitea?: GiteaConfig;
+	}
+
+	interface Context {
+		branchName: string;
+		changelog: string;
+		latestVersion: string;
+		name: string;
+		releaseUrl?: string;
+		repo: {
+			host: string;
+			owner: string;
+			project: string;
+			protocol: string;
+			remote: string;
+			repository: string;
+		};
+		version: string;
+	}
+
+	class Plugin {
+		config: Config;
+		context: Context;
+		log: {
+			error: (message: string) => void;
+			exec: (command: string) => void;
+			info: (message: string) => void;
+			verbose: (message: string) => void;
+			warn: (message: string) => void;
+		};
+		shell: {
+			exec: (command: string) => Promise<string>;
+		};
+
+		constructor(config: Config);
+
+		static disablePlugin(): void;
+		static isEnabled(config?: Config): boolean;
+		afterRelease(): Promise<void>;
+		beforeBump(): Promise<void>;
+		beforeRelease(): Promise<void>;
+		bump(): Promise<void>;
+		getIncrement(): string;
+		getIncrementedVersion(): string;
+		getIncrementedVersionCI(): string;
+		getInitialOptions(): unknown;
+		getLatestVersion(): string;
+		getName(): string;
+		init(): Promise<void>;
+		release(): Promise<void>;
+	}
+}
+
+interface GiteaConfig {
+	/** Gitea 服务器的完整 URL 地址 */
+	host: string;
+
+	/** 仓库所有者的用户名或组织名 */
+	owner: string;
+
+	/** 仓库名称 */
+	repository: string;
+
+	/** 是否启用发布创建功能 */
+	release?: boolean;
+
+	/** 发布标题的模板字符串，支持变量替换 */
+	releaseTitle?: string;
+
+	/** 发布说明的模板字符串，支持变量替换 */
+	releaseNotes?: string;
+
+	/** 是否标记为预发布版本 */
+	prerelease?: boolean;
+
+	/** 是否创建为草稿状态 */
+	draft?: boolean;
+
+	/** 存储 API token 的环境变量名称 */
+	tokenRef?: string;
+
+	/** API 请求的超时时间，单位为毫秒 */
+	timeout?: number;
+}

package/lib/index.d.ts

@@ -0,0 +1,79 @@
+import { Plugin, Config } from 'release-it';
+
+declare class GiteaPlugin extends Plugin {
+    private giteaConfig;
+    constructor(config: Config);
+    static isEnabled(config?: Config): boolean;
+    /**
+     * 获取并验证 Gitea 配置信息
+     * @returns 验证后的 Gitea 配置对象
+     * @throws 当配置缺失或无效时抛出错误
+     */
+    private getGiteaConfig;
+    /**
+     * 从环境变量获取 API token.
+     * @returns API token 字符串
+     * @throws 当 token 不存在时抛出错误
+     */
+    private getToken;
+    /**
+     * 构建完整的 API 请求 URL.
+     * @param endpoint API 端点路径
+     * @returns 完整的 API URL
+     */
+    private buildApiUrl;
+    /**
+     * 发送 HTTP 请求到 Gitea API.
+     * @param endpoint API 端点路径
+     * @param options 请求选项
+     * @param options.body 请求体数据
+     * @param options.method HTTP 方法
+     * @returns API 响应数据
+     * @throws 当请求失败时抛出错误
+     */
+    private apiRequest;
+    /**
+     * 检查指定标签的发布是否已存在.
+     * @param tagName Git 标签名
+     * @returns 发布是否存在
+     * @throws 当 API 请求失败时抛出错误
+     */
+    private releaseExists;
+    /**
+     * 创建新的 Gitea 发布.
+     * @param releaseData 发布数据
+     * @returns 创建的发布信息
+     * @throws 当创建失败时抛出错误
+     */
+    private createRelease;
+    /**
+     * 更新已存在的 Gitea 发布.
+     * @param tagName Git 标签名
+     * @param releaseData 更新的发布数据
+     * @returns 更新后的发布信息
+     * @throws 当更新失败时抛出错误
+     */
+    private updateRelease;
+    /**
+     * 替换模板字符串中的变量占位符.
+     * @param template 包含变量占位符的模板字符串
+     * @returns 替换变量后的字符串
+     */
+    private interpolate;
+    /**
+     * 初始化插件，验证配置和连接.
+     * @throws 当配置无效或连接失败时抛出错误
+     */
+    init(): Promise<void>;
+    /**
+     * 执行发布操作，创建或更新 Gitea 发布.
+     * @throws 当发布创建失败时抛出错误
+     */
+    release(): Promise<void>;
+    /**
+     * 发布完成后的清理和通知操作
+     */
+    afterRelease(): Promise<void>;
+}
+
+export { GiteaPlugin as default };

package/lib/index.js

@@ -0,0 +1,245 @@
+import fetch from "node-fetch";
+import { Plugin } from "release-it";
+class GiteaPlugin extends Plugin {
+  giteaConfig;
+  constructor(config) {
+    super(config);
+    this.giteaConfig = this.getGiteaConfig();
+  }
+  static isEnabled(config) {
+    return Boolean(config?.gitea?.release);
+  }
+  /**
+   * 获取并验证 Gitea 配置信息
+   * @returns 验证后的 Gitea 配置对象
+   * @throws 当配置缺失或无效时抛出错误
+   */
+  getGiteaConfig() {
+    const gitea = this.config.gitea;
+    if (!gitea) {
+      throw new Error("Gitea \u914D\u7F6E\u672A\u627E\u5230");
+    }
+    const config = {
+      draft: gitea.draft ?? false,
+      host: gitea.host,
+      owner: gitea.owner ?? this.context.repo.owner,
+      prerelease: gitea.prerelease ?? false,
+      release: gitea.release !== false,
+      releaseNotes: gitea.releaseNotes ?? "${changelog}",
+      releaseTitle: gitea.releaseTitle ?? "v${version}",
+      repository: gitea.repository ?? this.context.repo.repository,
+      timeout: gitea.timeout ?? 3e4,
+      tokenRef: gitea.tokenRef ?? "GITEA_TOKEN"
+    };
+    if (!config.host) {
+      throw new Error("Gitea host \u914D\u7F6E\u662F\u5FC5\u9700\u7684");
+    }
+    if (!config.owner) {
+      throw new Error("Gitea owner \u914D\u7F6E\u662F\u5FC5\u9700\u7684");
+    }
+    if (!config.repository) {
+      throw new Error("Gitea repository \u914D\u7F6E\u662F\u5FC5\u9700\u7684");
+    }
+    return config;
+  }
+  /**
+   * 从环境变量获取 API token.
+   * @returns API token 字符串
+   * @throws 当 token 不存在时抛出错误
+   */
+  getToken() {
+    const tokenRef = this.giteaConfig.tokenRef;
+    if (!tokenRef) {
+      throw new Error("Token \u73AF\u5883\u53D8\u91CF\u540D\u672A\u914D\u7F6E");
+    }
+    const token = process.env[tokenRef];
+    if (!token) {
+      throw new Error(`Gitea API token \u672A\u627E\u5230\u3002\u8BF7\u8BBE\u7F6E\u73AF\u5883\u53D8\u91CF ${tokenRef}`);
+    }
+    return token;
+  }
+  /**
+   * 构建完整的 API 请求 URL.
+   * @param endpoint API 端点路径
+   * @returns 完整的 API URL
+   */
+  buildApiUrl(endpoint) {
+    const host = this.giteaConfig.host.replace(/\/$/, "");
+    return `${host}/api/v1${endpoint}`;
+  }
+  /**
+   * 发送 HTTP 请求到 Gitea API.
+   * @param endpoint API 端点路径
+   * @param options 请求选项
+   * @param options.body 请求体数据
+   * @param options.method HTTP 方法
+   * @returns API 响应数据
+   * @throws 当请求失败时抛出错误
+   */
+  async apiRequest(endpoint, options = {}) {
+    const url = this.buildApiUrl(endpoint);
+    const token = this.getToken();
+    const requestOptions = {
+      body: options.body ? JSON.stringify(options.body) : void 0,
+      headers: {
+        Accept: "application/json",
+        Authorization: `token ${token}`,
+        "Content-Type": "application/json"
+      },
+      method: options.method ?? "GET",
+      timeout: this.giteaConfig.timeout
+    };
+    this.log.verbose(`\u53D1\u9001 ${requestOptions.method} \u8BF7\u6C42\u5230: ${url}`);
+    try {
+      const response = await fetch(url, requestOptions);
+      if (!response.ok) {
+        const errorText = await response.text();
+        throw new Error(
+          `Gitea API \u8BF7\u6C42\u5931\u8D25 (${response.status.toString()}): ${errorText}`
+        );
+      }
+      const data = await response.json();
+      return data;
+    } catch (error) {
+      if (error instanceof Error) {
+        throw new Error(`Gitea API \u8BF7\u6C42\u5931\u8D25: ${error.message}`);
+      }
+      throw error;
+    }
+  }
+  /**
+   * 检查指定标签的发布是否已存在.
+   * @param tagName Git 标签名
+   * @returns 发布是否存在
+   * @throws 当 API 请求失败时抛出错误
+   */
+  async releaseExists(tagName) {
+    try {
+      const endpoint = `/repos/${this.giteaConfig.owner}/${this.giteaConfig.repository}/releases/tags/${tagName}`;
+      await this.apiRequest(endpoint);
+      return true;
+    } catch (error) {
+      if (error instanceof Error && error.message.includes("404")) {
+        return false;
+      }
+      throw error;
+    }
+  }
+  /**
+   * 创建新的 Gitea 发布.
+   * @param releaseData 发布数据
+   * @returns 创建的发布信息
+   * @throws 当创建失败时抛出错误
+   */
+  async createRelease(releaseData) {
+    const endpoint = `/repos/${this.giteaConfig.owner}/${this.giteaConfig.repository}/releases`;
+    return await this.apiRequest(endpoint, {
+      body: releaseData,
+      method: "POST"
+    });
+  }
+  /**
+   * 更新已存在的 Gitea 发布.
+   * @param tagName Git 标签名
+   * @param releaseData 更新的发布数据
+   * @returns 更新后的发布信息
+   * @throws 当更新失败时抛出错误
+   */
+  async updateRelease(tagName, releaseData) {
+    const endpoint = `/repos/${this.giteaConfig.owner}/${this.giteaConfig.repository}/releases/tags/${tagName}`;
+    return await this.apiRequest(endpoint, {
+      body: releaseData,
+      method: "PATCH"
+    });
+  }
+  /**
+   * 替换模板字符串中的变量占位符.
+   * @param template 包含变量占位符的模板字符串
+   * @returns 替换变量后的字符串
+   */
+  interpolate(template) {
+    return template.replace(/\$\{version\}/g, this.context.version).replace(/\$\{latestVersion\}/g, this.context.latestVersion).replace(/\$\{changelog\}/g, this.context.changelog).replace(/\$\{name\}/g, this.context.name).replace(/\$\{repo\.owner\}/g, this.context.repo.owner).replace(/\$\{repo\.repository\}/g, this.context.repo.repository).replace(/\$\{branchName\}/g, this.context.branchName);
+  }
+  /**
+   * 初始化插件，验证配置和连接.
+   * @throws 当配置无效或连接失败时抛出错误
+   */
+  async init() {
+    this.log.info("\u521D\u59CB\u5316 Gitea \u63D2\u4EF6");
+    try {
+      this.getToken();
+      this.log.verbose("Gitea API token \u9A8C\u8BC1\u6210\u529F");
+    } catch (error) {
+      if (error instanceof Error) {
+        this.log.error(error.message);
+      }
+      throw error;
+    }
+    try {
+      const endpoint = `/repos/${this.giteaConfig.owner}/${this.giteaConfig.repository}`;
+      await this.apiRequest(endpoint);
+      this.log.verbose("Gitea API \u8FDE\u63A5\u6D4B\u8BD5\u6210\u529F");
+    } catch (error) {
+      if (error instanceof Error) {
+        this.log.error(`\u65E0\u6CD5\u8FDE\u63A5\u5230 Gitea \u4ED3\u5E93: ${error.message}`);
+      }
+      throw error;
+    }
+  }
+  /**
+   * 执行发布操作，创建或更新 Gitea 发布.
+   * @throws 当发布创建失败时抛出错误
+   */
+  async release() {
+    if (!this.giteaConfig.release) {
+      this.log.info("Gitea \u53D1\u5E03\u529F\u80FD\u5DF2\u7981\u7528");
+      return;
+    }
+    const tagName = `v${this.context.version}`;
+    const releaseTitle = this.interpolate(
+      this.giteaConfig.releaseTitle ?? "v${version}"
+    );
+    const releaseNotes = this.interpolate(
+      this.giteaConfig.releaseNotes ?? "${changelog}"
+    );
+    this.log.info(`\u51C6\u5907\u521B\u5EFA Gitea \u53D1\u5E03: ${releaseTitle}`);
+    const releaseData = {
+      body: releaseNotes,
+      draft: this.giteaConfig.draft ?? false,
+      name: releaseTitle,
+      prerelease: this.giteaConfig.prerelease ?? false,
+      tag_name: tagName
+    };
+    try {
+      const exists = await this.releaseExists(tagName);
+      let release;
+      if (exists) {
+        this.log.info(`\u53D1\u5E03 ${tagName} \u5DF2\u5B58\u5728\uFF0C\u6B63\u5728\u66F4\u65B0...`);
+        release = await this.updateRelease(tagName, releaseData);
+      } else {
+        this.log.info(`\u6B63\u5728\u521B\u5EFA\u65B0\u53D1\u5E03 ${tagName}...`);
+        release = await this.createRelease(releaseData);
+      }
+      this.log.info(`\u2705 Gitea \u53D1\u5E03\u521B\u5EFA\u6210\u529F: ${release.html_url}`);
+      this.context.releaseUrl = release.html_url;
+    } catch (error) {
+      if (error instanceof Error) {
+        this.log.error(`\u274C \u521B\u5EFA Gitea \u53D1\u5E03\u5931\u8D25: ${error.message}`);
+      }
+      throw error;
+    }
+  }
+  /**
+   * 发布完成后的清理和通知操作
+   */
+  async afterRelease() {
+    if (this.context.releaseUrl) {
+      this.log.info(`\u{1F389} \u53D1\u5E03\u5B8C\u6210! \u67E5\u770B\u53D1\u5E03: ${this.context.releaseUrl}`);
+    }
+    return Promise.resolve();
+  }
+}
+var index_default = GiteaPlugin;
+export {
+  index_default as default
+};

package/package.json

@@ -0,0 +1,91 @@
+{
+	"name": "release-it-gitea",
+	"version": "1.1.0",
+	"description": "release-it gitea plugin",
+	"keywords": [
+		"gitea",
+		"release-it",
+		"release-it-plugin"
+	],
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/lib-pack/release-it-gitea.git"
+	},
+	"license": "MIT",
+	"author": {
+		"name": "lyda",
+		"email": "1829913225@qq.com"
+	},
+	"type": "module",
+	"main": "lib/index.js",
+	"files": [
+		"LICENSE.md",
+		"README.md",
+		"lib/",
+		"package.json"
+	],
+	"scripts": {
+		"build": "tsup",
+		"format": "prettier .",
+		"lint": "eslint . --max-warnings 0",
+		"lint:knip": "knip",
+		"lint:md": "markdownlint \"**/*.md\" \".github/**/*.md\" --rules sentences-per-line",
+		"lint:packages": "pnpm dedupe --check",
+		"lint:spelling": "cspell \"**\" \".github/**/*\"",
+		"prepare": "husky",
+		"test": "vitest",
+		"tsc": "tsc"
+	},
+	"lint-staged": {
+		"*": "prettier --ignore-unknown --write"
+	},
+	"dependencies": {
+		"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/eslint-plugin-markdown": "2.0.2",
+		"@types/node": "22.13.10",
+		"@types/node-fetch": "^2.6.11",
+		"@vitest/coverage-v8": "3.0.9",
+		"@vitest/eslint-plugin": "1.1.38",
+		"console-fail-test": "0.5.0",
+		"cspell": "8.17.5",
+		"eslint": "9.22.0",
+		"eslint-plugin-jsdoc": "50.6.8",
+		"eslint-plugin-jsonc": "2.20.0",
+		"eslint-plugin-markdown": "5.1.0",
+		"eslint-plugin-n": "17.16.2",
+		"eslint-plugin-package-json": "0.29.0",
+		"eslint-plugin-perfectionist": "4.11.0",
+		"eslint-plugin-regexp": "2.7.0",
+		"eslint-plugin-yml": "1.17.0",
+		"husky": "9.1.7",
+		"knip": "5.46.0",
+		"lint-staged": "15.5.0",
+		"markdownlint": "0.37.4",
+		"markdownlint-cli": "0.44.0",
+		"prettier": "3.5.3",
+		"prettier-plugin-curly": "0.3.1",
+		"prettier-plugin-packagejson": "2.5.10",
+		"prettier-plugin-sh": "0.15.0",
+		"release-it": "19.0.3",
+		"sentences-per-line": "0.3.0",
+		"tsup": "8.4.0",
+		"typescript": "5.8.2",
+		"typescript-eslint": "8.26.1",
+		"vitest": "3.0.9"
+	},
+	"peerDependencies": {
+		"release-it": "^19.0.3"
+	},
+	"packageManager": "pnpm@10.4.0",
+	"engines": {
+		"node": ">=18.3.0"
+	},
+	"publishConfig": {
+		"provenance": true
+	}
+}