release-it-gitea 1.7.0 → 1.8.0

package/README.en.md

@@ -57,19 +57,19 @@ npx release-it
 
 ### Basic Configuration Options
 
-| Option         | Type    | Default                     | Description                    |
-| -------------- | ------- | --------------------------- | ------------------------------ |
-| `host`         | string  | Current repository host     | Gitea server URL               |
-| `owner`        | string  | Auto-detect from git remote | Repository owner               |
-| `repository`   | string  | Auto-detect from git remote | Repository name                |
-| `release`      | boolean | `true`                      | Whether to create release      |
-| `releaseTitle` | string  | `"v${version}"`             | Release title template         |
-| `releaseNotes` | string  | `"${changelog}"`            | Release notes template         |
-| `prerelease`   | boolean | `false`                     | Whether it's a prerelease      |
-| `draft`        | boolean | `false`                     | Whether it's a draft           |
-| `tokenRef`     | string  | `"GITEA_TOKEN"`             | API token environment variable |
-| `timeout`      | number  | `30000`                     | Request timeout (milliseconds) |
-| `assets`       | array   | `[]`                        | Additional asset files         |
+| Option         | Type                          | Default                     | Description                                                                        |
+| -------------- | ----------------------------- | --------------------------- | ---------------------------------------------------------------------------------- |
+| `host`         | string                        | Current repository host     | Gitea server URL                                                                   |
+| `owner`        | string                        | Auto-detect from git remote | Repository owner                                                                   |
+| `repository`   | string                        | Auto-detect from git remote | Repository name                                                                    |
+| `release`      | boolean                       | `true`                      | Whether to create release                                                          |
+| `releaseTitle` | string \| (context) => string | `"v${version}"`             | Release title template, supports variables and function callbacks                  |
+| `releaseNotes` | string \| (context) => string | `"${changelog}"`            | Release notes template, supports variables, Markdown format and function callbacks |
+| `prerelease`   | boolean                       | `false`                     | Whether it's a prerelease                                                          |
+| `draft`        | boolean                       | `false`                     | Whether it's a draft                                                               |
+| `tokenRef`     | string                        | `"GITEA_TOKEN"`             | API token environment variable                                                     |
+| `timeout`      | number                        | `30000`                     | Request timeout (milliseconds)                                                     |
+| `assets`       | array                         | `[]`                        | Additional asset files                                                             |
 
 ### Complete Configuration Example
 
@@ -261,6 +261,147 @@ The following variables can be used in `releaseTitle` and `releaseNotes`:
 | `${repo.repository}` | Repository name  | `my-repo`            |
 | `${branchName}`      | Branch name      | `main`               |
 
+### Function Callback Configuration
+
+In JavaScript configuration files, you can pass function callbacks for `releaseTitle` and `releaseNotes` for more flexible configuration:
+
+```js
+// .release-it.js
+module.exports = {
+	plugins: {
+		"release-it-gitea": {
+			host: "https://gitea.example.com",
+			owner: "your-username",
+			repository: "your-repo",
+			// Using a function to generate dynamic release titles
+			releaseTitle: (context) => {
+				const date = new Date().toISOString().split("T")[0];
+				return `🚀 ${context.name} v${context.version} (${date})`;
+			},
+			// Using a function to generate dynamic release notes
+			releaseNotes: (context) => {
+				const sections = context.changelog.split("\n## ");
+				const features = sections.find(
+					(s) => s.startsWith("Features") || s.startsWith("New Features"),
+				);
+				const fixes = sections.find(
+					(s) => s.startsWith("Bug Fixes") || s.startsWith("Fixes"),
+				);
+
+				return `## ${context.name} v${context.version} Release Notes
+        
+## ✨ New Features
+${features ? "## " + features : "None"}
+
+## 🐛 Bug Fixes
+${fixes ? "## " + fixes : "None"}
+
+## 📦 Installation
+\`\`\`
+npm install ${context.name}@${context.version}
+\`\`\``;
+			},
+			// Other configurations...
+		},
+	},
+};
+```
+
+Advantages of function callbacks:
+
+- Can perform complex logical processing
+- Can access the complete context object
+- Can dynamically generate content based on conditions
+- Can integrate external data or API results
+
+> **Note**: Function callbacks are only available when using JavaScript configuration files (such as `.release-it.js` or `.release-it.cjs`); string templates must be used in JSON configuration files.
+
+### Using NPM Packages
+
+`releaseTitle` and `releaseNotes` also support referencing external NPM packages using the `npm:` prefix to generate content:
+
+```json
+{
+	"plugins": {
+		"release-it-gitea": {
+			"releaseTitle": "npm:my-release-notes-generator",
+			"releaseNotes": "npm:my-changelog-formatter"
+		}
+	}
+}
+```
+
+How to use NPM packages:
+
+1. Create and publish an NPM package that exports the following methods:
+
+   ```js
+   // my-release-notes-generator package example
+   module.exports = {
+   	releaseTitle: function (context) {
+   		return `Release v${context.version} - ${new Date().toLocaleDateString()}`;
+   	},
+   	releaseNotes: function (context) {
+   		// Custom formatting logic
+   		return `# ${context.name} v${context.version}\n\n${context.changelog}`;
+   	},
+   };
+   ```
+
+2. Install the package:
+
+   ```bash
+   npm install --save-dev my-release-notes-generator
+   ```
+
+3. Reference in configuration:
+   ```json
+   {
+   	"releaseTitle": "npm:my-release-notes-generator",
+   	"releaseNotes": "npm:my-release-notes-generator"
+   }
+   ```
+
+Advantages of using NPM packages:
+
+- Can share the same release title and description format across multiple projects
+- Can maintain and update release format independently of the project
+- Supports more complex logic and dependencies
+- Can be used in JSON configurations, not limited to JavaScript configurations
+
+### Context Object Properties
+
+In function callbacks, you can access the following context object properties:
+
+| Property          | Type   | Description                     | Example Value                    |
+| ----------------- | ------ | ------------------------------- | -------------------------------- |
+| `version`         | string | Current version                 | `"1.2.3"`                        |
+| `latestVersion`   | string | Previous version                | `"1.2.2"`                        |
+| `changelog`       | string | Generated changelog content     | `"## Bug Fixes\n\n* Fixed..."`   |
+| `name`            | string | Project name                    | `"my-project"`                   |
+| `branchName`      | string | Current branch name             | `"main"`                         |
+| `releaseUrl`      | string | Release URL (only after update) | `"https://gitea.com/.../v1.2.3"` |
+| `repo`            | object | Repository related information  |                                  |
+| `repo.host`       | string | Repository host address         | `"gitea.example.com"`            |
+| `repo.owner`      | string | Repository owner                | `"username"`                     |
+| `repo.project`    | string | Project name                    | `"my-repo"`                      |
+| `repo.protocol`   | string | Repository protocol             | `"https"`                        |
+| `repo.remote`     | string | Remote repository name          | `"origin"`                       |
+| `repo.repository` | string | Repository name                 | `"my-repo"`                      |
+
+### Example: Using context properties to generate custom release titles
+
+```js
+releaseTitle: (context) => {
+	const emoji = context.version.includes("beta")
+		? "🧪"
+		: context.version.includes("alpha")
+			? "🚧"
+			: "🚀";
+	return `${emoji} ${context.name} v${context.version} [${context.branchName}]`;
+};
+```
+
 ### Template Usage Example
 
 ```json

package/README.md

@@ -389,7 +389,7 @@ npm install ${context.name}@${context.version}
 | `repo.remote`     | string | 远程仓库名称                  | `"origin"`                       |
 | `repo.repository` | string | 仓库名称                      | `"my-repo"`                      |
 
-**示例：使用 context 属性生成自定义发布标题**
+### 示例：使用 context 属性生成自定义发布标题
 
 ```js
 releaseTitle: (context) => {

package/lib/global.d.d.ts

@@ -2,6 +2,7 @@ declare module "release-it" {
 	interface Config {
 		getContext(): Context;
 		getContext(path: string): unknown;
+		isDryRun: boolean;
 		setContext(path: string, value: unknown): void;
 	}
 

package/lib/index.d.ts

@@ -5,7 +5,6 @@ declare class GiteaPlugin extends Plugin {
     /**
      * 获取并验证 Gitea 配置信息
      * @returns 验证后的 Gitea 配置对象
-     * @throws 当配置缺失或无效时抛出错误
      */
     private get giteaConfig();
     /**
@@ -99,9 +98,8 @@ declare class GiteaPlugin extends Plugin {
      */
     private processAsset;
     /**
-     * 处理单个附件配置
-     * @param releaseId 发布 ID
-     * @param config 附件配置
+     * 获取发布说明内容
+     * @returns 发布说明字符串
      */
     private getReleaseNotes;
     private getReleaseTitle;

package/lib/index.js

@@ -7,12 +7,11 @@ import { basename, dirname, join } from "path";
 import { Plugin } from "release-it";
 class GiteaPlugin extends Plugin {
   static isEnabled(config) {
-    return Boolean(config?.release !== false);
+    return config?.release !== false;
   }
   /**
    * 获取并验证 Gitea 配置信息
    * @returns 验证后的 Gitea 配置对象
-   * @throws 当配置缺失或无效时抛出错误
    */
   get giteaConfig() {
     const gitea = this.getContext();
@@ -102,7 +101,7 @@ class GiteaPlugin extends Plugin {
       if (!response.ok) {
         const errorText = await response.text();
         throw new Error(
-          `Gitea API \u8BF7\u6C42\u5931\u8D25 (${response.status.toString()}): ${errorText}`
+          `Gitea API \u8BF7\u6C42\u5931\u8D25 (${String(response.status)}): ${errorText}`
         );
       }
       const data = await response.json();
@@ -198,7 +197,7 @@ class GiteaPlugin extends Plugin {
       });
       return files;
     } catch (error) {
-      this.log.warn(`\u6587\u4EF6\u5339\u914D\u5931\u8D25: ${pattern}, \u9519\u8BEF: ${error}`);
+      this.log.warn(`\u6587\u4EF6\u5339\u914D\u5931\u8D25: ${pattern}, \u9519\u8BEF: ${String(error)}`);
       return [];
     }
   }
@@ -217,7 +216,7 @@ class GiteaPlugin extends Plugin {
       });
       output.on("close", () => {
         this.log.verbose(
-          `ZIP \u6587\u4EF6\u521B\u5EFA\u5B8C\u6210: ${outputPath} (${archive.pointer()} bytes)`
+          `ZIP \u6587\u4EF6\u521B\u5EFA\u5B8C\u6210: ${outputPath} (${String(archive.pointer())} bytes)`
         );
         resolve();
       });
@@ -232,7 +231,7 @@ class GiteaPlugin extends Plugin {
           archive.file(file, { name: relativePath });
         }
       }
-      archive.finalize();
+      void archive.finalize();
     });
   }
   /**
@@ -244,8 +243,12 @@ class GiteaPlugin extends Plugin {
    * @returns 上传结果
    */
   async uploadAsset(releaseId, filePath, fileName, label) {
+    if (this.config.isDryRun) {
+      this.log.info(`[\u6A21\u62DF\u6267\u884C] \u4E0A\u4F20\u9644\u4EF6: ${fileName}`);
+      return { id: 0 };
+    }
     const url = this.buildApiUrl(
-      `/repos/${this.giteaConfig.owner}/${this.giteaConfig.repository}/releases/${releaseId}/assets`
+      `/repos/${this.giteaConfig.owner}/${this.giteaConfig.repository}/releases/${String(releaseId)}/assets`
     );
     const token = this.getToken();
     const form = new FormData();
@@ -265,12 +268,14 @@ class GiteaPlugin extends Plugin {
       method: "POST",
       timeout: this.giteaConfig.timeout
     };
-    this.log.verbose(`\u4E0A\u4F20\u9644\u4EF6: ${fileName} \u5230\u53D1\u5E03 ${releaseId}`);
+    this.log.info(`\u4E0A\u4F20\u9644\u4EF6: ${fileName} \u5230\u53D1\u5E03 ${String(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}`);
+        throw new Error(
+          `\u9644\u4EF6\u4E0A\u4F20\u5931\u8D25 (${String(response.status)}): ${errorText}`
+        );
       }
       const result = await response.json();
       this.log.info(`\u2705 \u9644\u4EF6\u4E0A\u4F20\u6210\u529F: ${fileName}`);
@@ -292,14 +297,14 @@ class GiteaPlugin extends Plugin {
       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...`);
+    this.log.info(`\u5F00\u59CB\u4E0A\u4F20 ${String(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}`
+          `\u9644\u4EF6\u5904\u7406\u5931\u8D25: ${JSON.stringify(asset)}, \u9519\u8BEF: ${String(error)}`
         );
       }
     }
@@ -317,12 +322,12 @@ class GiteaPlugin extends Plugin {
       return;
     }
     if (config.type === "zip") {
-      const zipName = config.name || `${basename(config.path)}.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) {
+      } catch {
       }
       await this.createZipArchive(
         files,
@@ -333,32 +338,39 @@ class GiteaPlugin extends Plugin {
       const { unlinkSync } = await import("fs");
       try {
         unlinkSync(tempZipPath);
-      } catch (error) {
+      } catch {
         this.log.warn(`\u6E05\u7406\u4E34\u65F6\u6587\u4EF6\u5931\u8D25: ${tempZipPath}`);
       }
     } else {
       for (const file of files) {
-        const fileName = config.name || basename(file);
+        const fileName = config.name ?? basename(file);
         await this.uploadAsset(releaseId, file, fileName, config.label);
       }
     }
   }
   /**
-   * 处理单个附件配置
-   * @param releaseId 发布 ID
-   * @param config 附件配置
+   * 获取发布说明内容
+   * @returns 发布说明字符串
    */
-  getReleaseNotes() {
+  async getReleaseNotes() {
     const releaseNotes = this.giteaConfig.releaseNotes;
     if (typeof releaseNotes === "string") {
       if (releaseNotes.startsWith("npm:")) {
         const npmPackage = releaseNotes.slice(4);
         try {
-          const npmHandler = require(npmPackage);
-          if (typeof npmHandler !== "function") {
+          const npmHandler = await import(npmPackage);
+          if (typeof npmHandler !== "function" && // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+          typeof npmHandler.default !== "function") {
             throw new Error(`${npmPackage} not found npm`);
           }
-          return npmHandler.releaseNotes(this.config.getContext());
+          const handler = (
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+            typeof npmHandler.default === "function" ? (
+              // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+              npmHandler.default
+            ) : npmHandler
+          );
+          return handler.releaseNotes(this.config.getContext());
         } catch (error) {
           console.error(error);
           throw new Error(`${npmPackage} not found npm`);
@@ -371,17 +383,25 @@ class GiteaPlugin extends Plugin {
     }
     return this.config.getContext("changelog");
   }
-  getReleaseTitle() {
+  async getReleaseTitle() {
     const releaseTitle = this.giteaConfig.releaseTitle;
     if (typeof releaseTitle === "string") {
       if (releaseTitle.startsWith("npm:")) {
         const npmPackage = releaseTitle.slice(4);
         try {
-          const npmHandler = require(npmPackage);
-          if (typeof npmHandler !== "function") {
+          const npmHandler = await import(npmPackage);
+          if (typeof npmHandler !== "function" && // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+          typeof npmHandler.default !== "function") {
             throw new Error(`${npmPackage} not found npm`);
           }
-          return npmHandler.releaseTitle(this.config.getContext());
+          const handler = (
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+            typeof npmHandler.default === "function" ? (
+              // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+              npmHandler.default
+            ) : npmHandler
+          );
+          return handler.releaseTitle(this.config.getContext());
         } catch (error) {
           console.error(error);
           throw new Error(`${npmPackage} not found npm`);
@@ -403,9 +423,10 @@ class GiteaPlugin extends Plugin {
       this.log.info("Gitea \u53D1\u5E03\u529F\u80FD\u5DF2\u7981\u7528");
       return;
     }
+    const isDryRun = this.config.isDryRun;
     const tagName = this.config.getContext("tagName");
-    const releaseTitle = this.getReleaseTitle();
-    const releaseNotes = this.getReleaseNotes();
+    const releaseTitle = await this.getReleaseTitle();
+    const releaseNotes = await this.getReleaseNotes();
     this.log.info(`\u51C6\u5907\u521B\u5EFA Gitea \u53D1\u5E03: ${releaseTitle}`);
     const releaseData = {
       body: releaseNotes,
@@ -414,6 +435,14 @@ class GiteaPlugin extends Plugin {
       prerelease: this.giteaConfig.prerelease ?? false,
       tag_name: tagName
     };
+    if (isDryRun) {
+      this.log.info(`[\u6A21\u62DF\u6267\u884C] \u6B63\u5728\u521B\u5EFA/\u66F4\u65B0\u53D1\u5E03 ${tagName}`);
+      this.log.verbose(`\u53D1\u5E03\u6570\u636E: ${JSON.stringify(releaseData)}`);
+      if (this.giteaConfig.assets && this.giteaConfig.assets.length > 0) {
+        await this.uploadAssets(0);
+      }
+      return;
+    }
     try {
       const exists = await this.releaseExists(tagName);
       let release;

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "release-it-gitea",
-	"version": "1.7.0",
-	"description": "release-it gitea plugin",
+	"version": "1.8.0",
+	"description": "release-it gitea plugin.",
 	"keywords": [
 		"gitea",
 		"release-it",
@@ -19,22 +19,20 @@
 	"type": "module",
 	"main": "lib/index.js",
 	"files": [
-		"LICENSE.md",
-		"README.md",
-		"lib/",
-		"package.json"
+		"lib/"
 	],
 	"scripts": {
 		"build": "tsup",
 		"demo": "node scripts/demo.js",
 		"format": "prettier .",
 		"lint": "eslint . --max-warnings 0",
+		"lint:all": "pnpm run lint && pnpm run lint:knip && pnpm run lint:md && pnpm run lint:packages && pnpm run lint:spelling",
 		"lint:knip": "knip",
-		"lint:md": "markdownlint \"**/*.md\" \".github/**/*.md\" --rules sentences-per-line",
+		"lint:md": "markdownlint \"**/*.md\" \".github/**/*.md\"",
 		"lint:packages": "pnpm dedupe --check",
 		"lint:spelling": "cspell \"**\" \".github/**/*\"",
 		"prepare": "husky",
-		"test": "vitest",
+		"test": "vitest run",
 		"test:e2e": "vitest run test/",
 		"test:manual": "node scripts/test-manual.js",
 		"test:unit": "vitest run src/",
@@ -46,45 +44,41 @@
 	"dependencies": {
 		"archiver": "^7.0.1",
 		"form-data": "^4.0.3",
-		"glob": "^11.0.3",
+		"glob": "^13.0.0",
 		"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/archiver": "^7.0.0",
 		"@types/node": "22.13.10",
-		"@types/node-fetch": "^2.6.11",
-		"@vitest/coverage-v8": "3.0.9",
+		"@vitest/coverage-v8": "4.0.16",
 		"@vitest/eslint-plugin": "1.1.38",
-		"console-fail-test": "0.5.0",
-		"cspell": "8.17.5",
+		"console-fail-test": "0.6.1",
+		"cspell": "9.4.0",
 		"eslint": "9.22.0",
-		"eslint-plugin-jsdoc": "50.6.8",
+		"eslint-plugin-jsdoc": "61.5.0",
 		"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",
+		"eslint-plugin-package-json": "0.87.1",
+		"eslint-plugin-perfectionist": "5.2.0",
+		"eslint-plugin-regexp": "2.10.0",
+		"eslint-plugin-yml": "1.19.1",
 		"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",
+		"knip": "5.79.0",
+		"lint-staged": "16.2.7",
+		"markdownlint": "0.40.0",
+		"markdownlint-cli": "0.47.0",
+		"prettier": "3.7.4",
+		"prettier-plugin-curly": "0.4.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"
+		"prettier-plugin-sh": "0.18.0",
+		"release-it": "19.2.2",
+		"tsup": "8.5.1",
+		"typescript": "5.9.3",
+		"typescript-eslint": "8.51.0",
+		"vitest": "4.0.16"
 	},
 	"peerDependencies": {
 		"release-it": "^19.0.3"
@@ -95,5 +89,12 @@
 	},
 	"publishConfig": {
 		"provenance": true
+	},
+	"pnpm": {
+		"overrides": {
+			"form-data": "^4.0.5",
+			"glob": "^11.1.0",
+			"vite": "^6.4.0"
+		}
 	}
 }