keepchanges 1.0.0-beta.1 → 1.0.0-beta.2

package/README.md

@@ -150,7 +150,8 @@ different commits.
 
 Stable releases compare with the previous stable tag. Prereleases compare with
 the nearest previous tag. With `--release`, `--dry` takes precedence and
-prevents all file writes and remote mutations.
+prevents all file writes and remote mutations. Its manual URL opens a new
+Release for a new tag and the edit page for an existing tag.
 
 > [!NOTE]
 > A regular `--release` without a token still writes files, commits, tags, and

package/README.zh-CN.md

@@ -143,7 +143,8 @@ GitHub 和 Gitea 均支持作者解析和 Release 发布；Gitea 使用 `GITEA_T
 时会停止，不会强制覆盖。
 
 稳定版本会与前一个稳定 tag 对比，预发布版本会与最近的前一个 tag 对比。与
-`--release` 搭配的 `--dry` 优先级最高，不会执行任何写入或远程修改。
+`--release` 搭配的 `--dry` 优先级最高，不会执行任何写入或远程修改。手动链接
+会为新 tag 打开创建 Release 页面，为已有 tag 打开编辑页面。
 
 > [!NOTE]
 > 没有 token 的普通 `--release` 仍会执行本地写入、commit、tag 和 push，

package/dist/cli.mjs

@@ -8,7 +8,7 @@ import { resolve } from "node:path";
 import ansis from "ansis";
 import { x } from "tinyexec";
 //#region package.json
-var version = "1.0.0-beta.1";
+var version = "1.0.0-beta.2";
 //#endregion
 //#region src/git.ts
 async function git(cwd, ...args) {
@@ -58,6 +58,7 @@ async function readGitCommits(cwd, from, to) {
 //#region src/repositories/gitea.ts
 const giteaRepository = {
 	name: "Gitea",
+	tokenEnv: "GITEA_TOKEN",
 	parse(source) {
 		try {
 			const url = new URL(source.replace(/^git\+/, ""));
@@ -83,7 +84,8 @@ const giteaRepository = {
 	compareUrl(repository, from, to) {
 		return `${repository.webUrl}/compare/${from}...${to}`;
 	},
-	manualReleaseUrl(repository, release) {
+	manualReleaseUrl(repository, release, action) {
+		if (action === "edit") return `${repository.webUrl}/releases/edit/${encodeURIComponent(release.tag)}`;
 		const url = new URL(`${repository.webUrl}/releases/new`);
 		url.search = new URLSearchParams({ tag: release.tag }).toString();
 		return url.toString();
@@ -143,6 +145,7 @@ const giteaRepository = {
 //#region src/repositories/github.ts
 const githubRepository = {
 	name: "GitHub",
+	tokenEnv: "GITHUB_TOKEN",
 	parse(source) {
 		const match = /github\.com[:/]([^/]+\/[^/]+?)(?:\.git)?$/.exec(source);
 		if (!match) return;
@@ -164,7 +167,8 @@ const githubRepository = {
 	compareUrl(repository, from, to) {
 		return `${repository.webUrl}/compare/${from}...${to}`;
 	},
-	manualReleaseUrl(repository, release) {
+	manualReleaseUrl(repository, release, action) {
+		if (action === "edit") return `${repository.webUrl}/releases/edit/${encodeURIComponent(release.tag)}`;
 		const url = new URL(`${repository.webUrl}/releases/new`);
 		url.search = new URLSearchParams({
 			title: release.name,
@@ -288,9 +292,9 @@ function printChangesPreview(preview, stdout, colors) {
 		""
 	].join("\n"));
 }
-function printManualReleaseUrl(repository, release, stdout, colors) {
-	const url = repository.provider.manualReleaseUrl?.(repository, release);
-	if (url) stdout(`${colors.yellow("Using the following link to create it manually:")}\n${colors.yellow(url)}\n`);
+function printManualReleaseUrl(repository, release, stdout, colors, action = "create") {
+	const url = repository.provider.manualReleaseUrl?.(repository, release, action);
+	if (url) stdout(`${colors.yellow(`Using the following link to ${action} it manually:`)}\n${colors.yellow(url)}\n`);
 }
 function printPublishedRelease(provider, result, stdout, colors) {
 	const action = result.action.charAt(0).toUpperCase() + result.action.slice(1);
@@ -326,7 +330,7 @@ async function createChanges(options, environment) {
 	const to = releaseRef || options.to;
 	const comparisonFrom = from || (repository ? await git(environment.cwd, "rev-list", "--max-parents=0", to).then((value) => value.trim()) : "");
 	const commits = parseCommits(await readGitCommits(environment.cwd, from, to));
-	if (token && repository && !(options.release && options.dry)) await repository.provider.resolveAuthors?.(commits, repository, token, environment.fetch ?? globalThis.fetch);
+	if (token && repository) await repository.provider.resolveAuthors?.(commits, repository, token, environment.fetch ?? globalThis.fetch);
 	const style = {
 		emoji: options.emoji,
 		capitalize: options.capitalize,
@@ -355,13 +359,13 @@ async function createChanges(options, environment) {
 		printChangesPreview(preview, stdout, colors);
 		if (options.release) {
 			stdout(`${colors.yellow("Dry run. Release skipped.")}\n\n`);
-			printManualReleaseUrl(repository, repositoryRelease, stdout, colors);
+			printManualReleaseUrl(repository, repositoryRelease, stdout, colors, taggedCommit ? "edit" : "create");
 		}
 		return;
 	}
 	if (options.release && taggedCommit) {
 		if (!remoteTaggedCommit) await git(environment.cwd, "push", "origin", `refs/tags/${tag}`);
-		await publishRelease(repository, repositoryRelease, token, preview, environment);
+		await publishRelease(repository, repositoryRelease, token, preview, environment, "edit");
 		return;
 	}
 	const outputPath = resolve(environment.cwd, options.output);
@@ -390,14 +394,14 @@ async function commitReleaseFiles(options, cwd, outputPath, versionPath, release
 	const commitMessage = versionPath && !versionChanges.trim() ? `docs(changelog): ${releaseExists ? "update" : "add"} v${options.version} release notes` : `chore(release): v${options.version}`;
 	await git(cwd, ...resolveGitIdentity(options.author), "commit", "-m", commitMessage, ...options.author ? ["--author", options.author] : [], "--only", "--", ...releasePaths);
 }
-async function publishRelease(repository, release, token, preview, environment) {
+async function publishRelease(repository, release, token, preview, environment, manualAction = "create") {
 	const stdout = environment.stdout ?? ((value) => process.stdout.write(value));
 	const colors = environment.colors ?? ansis;
 	printChangesPreview(preview, stdout, colors);
 	if (!token || !repository.provider.publishRelease) {
 		if (!repository.provider.manualReleaseUrl) throw new Error("A repository token is required to release");
-		stdout(`${colors.red(`No ${repository.provider.name} token found, specify it via --token or environment variable. Release skipped.`)}\n\n`);
-		printManualReleaseUrl(repository, release, stdout, colors);
+		stdout(`${colors.red(`No ${repository.provider.name} token found, specify it via --token or ${repository.provider.tokenEnv} env. Release skipped.`)}\n\n`);
+		printManualReleaseUrl(repository, release, stdout, colors, manualAction);
 		return;
 	}
 	const result = await repository.provider.publishRelease(repository, release, token, environment.fetch ?? globalThis.fetch);

package/dist/index.d.mts

@@ -24,8 +24,10 @@ interface RepositoryReleaseResult {
   url: string;
   action: 'created' | 'updated';
 }
+type ManualReleaseAction = 'create' | 'edit';
 interface RepositoryProvider {
   name: string;
+  tokenEnv: string;
   parse: (source: string) => Repository | undefined;
   token: (explicit: string | undefined, env: NodeJS.ProcessEnv) => string | undefined;
   commitUrl: (repository: Repository, hash: string) => string;
@@ -33,7 +35,7 @@ interface RepositoryProvider {
   compareUrl: (repository: Repository, from: string, to: string) => string;
   resolveAuthors?: (commits: RepositoryCommit[], repository: Repository, token: string, fetch: typeof globalThis.fetch) => Promise<void>;
   publishRelease?: (repository: Repository, release: RepositoryRelease, token: string, fetch: typeof globalThis.fetch) => Promise<RepositoryReleaseResult>;
-  manualReleaseUrl?: (repository: Repository, release: RepositoryRelease) => string;
+  manualReleaseUrl?: (repository: Repository, release: RepositoryRelease, action?: ManualReleaseAction) => string;
 }
 //#endregion
 //#region src/git.d.ts
@@ -149,4 +151,4 @@ declare function writeChangelog(path: string, changelog: string): Promise<void>;
 declare function hasRelease(changelog: string, version: string): boolean;
 declare function insertRelease(changelog: string, release: string): string;
 //#endregion
-export { type ChangelogConfig, type ChangelogConfigOverrides, type ChangelogMessages, type ChangelogSectionConfig, type Commit, type GenerateChangelogOptions, type GeneratedChangelog, type KeepChangesConfig, type RawCommit, type Repository, type RepositoryAuthor, type RepositoryCommit, type RepositoryProvider, type RepositoryRelease, type RepositoryReleaseResult, defaultConfig, generateChangelog, hasRelease, insertRelease, parseCommit, parseCommits, readChangelog, resolveChangelogConfig, writeChangelog };
+export { type ChangelogConfig, type ChangelogConfigOverrides, type ChangelogMessages, type ChangelogSectionConfig, type Commit, type GenerateChangelogOptions, type GeneratedChangelog, type KeepChangesConfig, type ManualReleaseAction, type RawCommit, type Repository, type RepositoryAuthor, type RepositoryCommit, type RepositoryProvider, type RepositoryRelease, type RepositoryReleaseResult, defaultConfig, generateChangelog, hasRelease, insertRelease, parseCommit, parseCommits, readChangelog, resolveChangelogConfig, writeChangelog };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "keepchanges",
   "type": "module",
-  "version": "1.0.0-beta.1",
+  "version": "1.0.0-beta.2",
   "description": "Generate and maintain CHANGELOG.md from Conventional Commits.",
   "author": "edram",
   "license": "MIT",
@@ -41,19 +41,19 @@
   "devDependencies": {
     "@antfu/eslint-config": "^9.2.0",
     "@types/node": "^26.1.1",
-    "bumpp": "^11.1.0",
     "eslint": "^10.7.0",
     "tsdown": "^0.22.5",
+    "tsx": "^4.23.8",
     "typescript": "^6.0.3",
     "vitest": "^4.1.10"
   },
   "scripts": {
     "build": "tsdown",
     "dev": "tsdown --watch",
+    "start": "tsx ./src/cli.ts",
     "lint": "eslint",
     "lint:fix": "eslint --fix",
     "test": "pnpm run build && vitest run",
-    "typecheck": "tsc --noEmit",
-    "release": "bumpp"
+    "typecheck": "tsc --noEmit"
   }
 }