@icebreakers/changelog-github 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 ice breaker
+
+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,77 @@
+# @icebreakers/changelog-github
+
+- [简体中文指南](./README.zh.md)
+
+## Overview
+
+`@icebreakers/changelog-github` is a drop-in replacement for `@changesets/changelog-github` that keeps the familiar tuple signature while adding repo-aware formatting tweaks we rely on across Icebreaker workspaces. It renders richer metadata, supports custom summary hints, and boots with dotenv so local CLI runs behave the same as CI.
+
+## Requirements
+
+- Node.js 18 or newer
+- A GitHub token exposed via `GITHUB_TOKEN`, `GH_TOKEN`, or `.env`
+
+## Installation
+
+```bash
+pnpm add -D @changesets/cli @icebreakers/changelog-github
+```
+
+## Quick Start
+
+Point the Changesets config at the Icebreaker formatter and declare your repository slug:
+
+```json
+{
+  "changelog": [
+    "@icebreakers/changelog-github",
+    { "repo": "org/repo" }
+  ]
+}
+```
+
+Run `pnpm changeset` as usual—generated changelogs will now use the enhanced formatter.
+
+## Key Differences from `@changesets/changelog-github`
+
+- **Summary tags** – recognises leading `pr:`, `commit:`, and `author:` / `user:` directives (case-insensitive) to override GitHub metadata while keeping the rest of the summary intact.
+- **Short commit links** – when you supply a `commit:` tag, the formatter renders the shortened SHA as a hyperlink rather than just the full URL.
+- **Release type callout** – appends a `> MAJOR release` style block for non-`none` releases so changelog readers can scan the impact quickly.
+- **Dotenv bootstrapping** – automatically loads `.env` before hitting the GitHub API, matching local development to CI without extra wiring.
+- **Dependency section** – lists dependency bumps with consistent Markdown indentation and links any backing commits for extra context.
+
+All other behaviours (tuple arguments, required `repo` option, rendered layout) remain compatible with the upstream formatter, so migrating simply switches the package name.
+
+## Writing Changeset Summaries
+
+Leverage the summary tags to control the metadata the formatter displays:
+
+```
+pr: #42
+commit: 1234567890abcdef1234567890abcdef12345678
+author: @octocat
+
+Add optional `tailwind-config` flag to the lint preset
+
+- accepts a relative path to `tailwind.config.ts`
+- falls back to the workspace root when unset
+```
+
+The rendered changelog entry becomes:
+
+```
+- Add optional `tailwind-config` flag to the lint preset (sonofmagic/dev-configs#42 · `1234567` · Thanks [@octocat](https://github.com/octocat)!)
+  - accepts a relative path to `tailwind.config.ts`
+  - falls back to the workspace root when unset
+> MINOR release
+```
+
+## GitHub Authentication
+
+Set `GITHUB_TOKEN` (or `GH_TOKEN`) with a token that can read public repo metadata. During local development you can store it in `.env`; the formatter calls `dotenv/config` automatically, so no extra setup is required.
+
+## Troubleshooting
+
+- **Missing repo error** – ensure the tuple includes your `org/repo` string; the formatter throws early when it is absent.
+- **Empty metadata** – verify the GitHub token is available to the process and that the commit/PR exists in the target repo.
+- **Summary tags ignored** – tags must appear at the top of the summary, each on its own line, before the main description content.

package/README.zh.md

@@ -0,0 +1,75 @@
+# @icebreakers/changelog-github
+
+## 概述
+
+`@icebreakers/changelog-github` 是 `@changesets/changelog-github` 的无缝替代版本。它保留原有的元组写法，却额外提供了我们在 Icebreaker 团队常用的格式优化：支持摘要里的自定义指令、更友好的提交链接，并且自动加载 dotenv，确保本地与 CI 的输出一致。
+
+## 环境要求
+
+- Node.js 18+
+- 通过 `GITHUB_TOKEN`、`GH_TOKEN` 或 `.env` 暴露 GitHub Token
+
+## 安装
+
+```bash
+pnpm add -D @changesets/cli @icebreakers/changelog-github
+```
+
+## 快速开始
+
+在 `.changeset/config.json` 中切换 changelog 生成器，并声明仓库地址：
+
+```json
+{
+  "changelog": [
+    "@icebreakers/changelog-github",
+    { "repo": "org/repo" }
+  ]
+}
+```
+
+之后执行 `pnpm changeset` 即可，生成的 changelog 会使用增强版格式器。
+
+## 与 `@changesets/changelog-github` 的差异
+
+- **摘要指令**：额外识别位于摘要首部的 `pr:`、`commit:`、`author:` / `user:`（不区分大小写），用于覆盖 GitHub 拉取的元数据，同时保留正文内容。
+- **短哈希链接**：当提供 `commit:` 指令时，会以短 SHA 生成链接，而不是仅展示完整 URL，阅读体验更好。
+- **版本类型提示**：对非 `none` 版本自动附加 `> MAJOR release`、`> MINOR release` 等提示，方便读者快速掌握影响范围。
+- **自动加载 dotenv**：在访问 GitHub API 前调用 `dotenv`，本地 CLI 与 CI 行为保持一致，无需额外手动引入。
+- **依赖更新板块**：列出依赖升级时，会根据变更集补全提交链接，并统一 Markdown 缩进，便于对齐阅读。
+
+其它行为（元组参数、必须提供 `repo` 选项、基础排版）与上游保持兼容，因此迁移仅需替换包名。
+
+## 编写变更摘要的技巧
+
+可以借助摘要指令精准控制展示的元数据：
+
+```
+pr: #42
+commit: 1234567890abcdef1234567890abcdef12345678
+author: @octocat
+
+为 lint preset 新增可选的 `tailwind-config` 配置项
+
+- 接受相对路径指向 `tailwind.config.ts`
+- 未设置时默认读取工作区根目录
+```
+
+最终 changelog 会渲染为：
+
+```
+- 为 lint preset 新增可选的 `tailwind-config` 配置项 (sonofmagic/dev-configs#42 · `1234567` · Thanks [@octocat](https://github.com/octocat)!)
+  - 接受相对路径指向 `tailwind.config.ts`
+  - 未设置时默认读取工作区根目录
+> MINOR release
+```
+
+## GitHub 鉴权
+
+设置具备读取公开仓库权限的 `GITHUB_TOKEN`（或 `GH_TOKEN`）。本地开发时可放在 `.env` 中；由于格式器会自动执行 `dotenv/config`，无需额外配置。
+
+## 常见问题
+
+- **缺少 repo 报错**：确认元组里包含 `org/repo` 字符串，缺失时格式器会立即抛错。
+- **元数据为空**：检查 GitHub Token 是否生效，以及提交 / PR 是否存在于对应仓库。
+- **摘要指令未生效**：指令需要放在摘要最顶部，并且每行单独书写；正文内容必须位于指令之后。

package/dist/index.cjs

@@ -0,0 +1,170 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } }// src/index.ts
+var _getgithubinfo = require('@changesets/get-github-info');
+var _dotenv = require('dotenv');
+_dotenv.config.call(void 0, );
+var releaseTypeMap = {
+  major: { icon: "\u{1F680}", label: "Major" },
+  minor: { icon: "\u2728", label: "Minor" },
+  patch: { icon: "\u{1F41B}", label: "Patch" },
+  none: { icon: "\u{1F4DD}", label: "Update" }
+};
+function resolveReleaseType(type) {
+  if (type && type in releaseTypeMap) {
+    return type;
+  }
+  return "none";
+}
+function assertRepo(options) {
+  if (!options || !options.repo) {
+    throw new Error(
+      'Please provide a repo to this changelog generator like this:\n"changelog": ["@icebreakers/changelog-github", { "repo": "org/repo" }]'
+    );
+  }
+}
+async function collectDependencyReferences(changesets, repo) {
+  const references = await Promise.all(
+    changesets.map(async (cs) => {
+      if (!cs.commit) {
+        return null;
+      }
+      const { links } = await _getgithubinfo.getInfo.call(void 0, {
+        repo,
+        commit: cs.commit
+      });
+      return links.commit;
+    })
+  );
+  return references.filter((link) => Boolean(link));
+}
+function formatDependencyLine(references, dependenciesUpdated) {
+  const dependencySummaries = dependenciesUpdated.map(
+    (dependency) => `\`${dependency.name}\` @ ${dependency.newVersion}`
+  );
+  const segments = [];
+  if (dependencySummaries.length > 0) {
+    segments.push(dependencySummaries.join(", "));
+  }
+  if (references.length > 0) {
+    segments.push(references.join(" \xB7 "));
+  }
+  const details = segments.join(" \xB7 ");
+  return details.length > 0 ? `- \u{1F4E6} Updated dependencies: ${details}` : "- \u{1F4E6} Updated dependencies";
+}
+function parseSummary(summary) {
+  let prNumber;
+  let commitRef;
+  const users = [];
+  const cleanedSummary = summary.replace(/^\s*(?:pr|pull|pull\s+request):\s*#?(\d+)/im, (_, pr) => {
+    const num = Number(pr);
+    if (!Number.isNaN(num)) {
+      prNumber = num;
+    }
+    return "";
+  }).replace(/^\s*commit:\s*(\S+)/im, (_, commit) => {
+    commitRef = commit;
+    return "";
+  }).replace(/^\s*(?:author|user):\s*@?(\S+)/gim, (_, user) => {
+    users.push(user);
+    return "";
+  }).trim();
+  const [headline = "", ...restLines] = cleanedSummary.split("\n").map((line) => line.trimRight());
+  const detailLines = restLines.map((line) => line.trim()).map((line) => line.replace(/^\s*[-*]\s*/, "")).filter((line) => line.length > 0);
+  return {
+    headline,
+    detailLines,
+    prNumber,
+    commitRef,
+    users
+  };
+}
+async function resolveLinks(repo, parsed, changesetCommit) {
+  if (parsed.prNumber !== void 0) {
+    const { links } = await _getgithubinfo.getInfoFromPullRequest.call(void 0, {
+      repo,
+      pull: parsed.prNumber
+    });
+    if (parsed.commitRef) {
+      const shortCommitId = parsed.commitRef.slice(0, 7);
+      links.commit = `[\`${shortCommitId}\`](https://github.com/${repo}/commit/${parsed.commitRef})`;
+    }
+    return links;
+  }
+  const commitToUse = _nullishCoalesce(parsed.commitRef, () => ( changesetCommit));
+  if (commitToUse) {
+    const { links } = await _getgithubinfo.getInfo.call(void 0, {
+      repo,
+      commit: commitToUse
+    });
+    return links;
+  }
+  return {
+    commit: null,
+    pull: null,
+    user: null
+  };
+}
+function buildUserMentions(users, fallbackUser) {
+  if (users.length > 0) {
+    return users.map((username) => `[@${username}](https://github.com/${username})`).join(", ");
+  }
+  return _nullishCoalesce(fallbackUser, () => ( ""));
+}
+var changelogFunctions = {
+  async getDependencyReleaseLine(changesets, dependenciesUpdated, options) {
+    assertRepo(options);
+    const { repo } = options;
+    if (dependenciesUpdated.length === 0) {
+      return "";
+    }
+    const references = await collectDependencyReferences(
+      changesets,
+      repo
+    );
+    return formatDependencyLine(references, dependenciesUpdated);
+  },
+  async getReleaseLine(changeset, type, options) {
+    assertRepo(options);
+    const { repo } = options;
+    const parsedSummary = parseSummary(changeset.summary);
+    const resolvedType = resolveReleaseType(type);
+    const links = await resolveLinks(
+      repo,
+      parsedSummary,
+      changeset.commit
+    );
+    const userMentions = buildUserMentions(
+      parsedSummary.users,
+      links.user
+    );
+    const headlineText = parsedSummary.headline || "Miscellaneous improvements";
+    const detailText = parsedSummary.detailLines.join(" \xB7 ");
+    const metaSegments = [];
+    if (links.pull) {
+      metaSegments.push(links.pull);
+    }
+    if (links.commit) {
+      metaSegments.push(links.commit);
+    }
+    if (userMentions) {
+      metaSegments.push(`Thanks ${userMentions}`);
+    }
+    if (resolvedType !== "none") {
+      metaSegments.push(`${releaseTypeMap[resolvedType].label} release`);
+    }
+    const trailingSegments = [
+      detailText,
+      metaSegments.join(" \xB7 ")
+    ].filter((segment) => segment.length > 0);
+    const suffix = trailingSegments.length ? ` \u2014 ${trailingSegments.join(" \xB7 ")}` : "";
+    return `
+
+- ${releaseTypeMap[resolvedType].icon} **${headlineText}**${suffix}`;
+  }
+};
+var index_default = changelogFunctions;
+var { getDependencyReleaseLine, getReleaseLine } = changelogFunctions;
+
+
+
+
+exports.default = index_default; exports.getDependencyReleaseLine = getDependencyReleaseLine; exports.getReleaseLine = getReleaseLine;

package/dist/index.d.cts

@@ -0,0 +1,11 @@
+import * as _changesets_types from '@changesets/types';
+import { ChangelogFunctions } from '@changesets/types';
+
+declare const changelogFunctions: ChangelogFunctions;
+
+declare const getDependencyReleaseLine: _changesets_types.GetDependencyReleaseLine;
+declare const getReleaseLine: _changesets_types.GetReleaseLine;
+
+// @ts-ignore
+export = changelogFunctions;
+export { getDependencyReleaseLine, getReleaseLine };

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+import * as _changesets_types from '@changesets/types';
+import { ChangelogFunctions } from '@changesets/types';
+
+declare const changelogFunctions: ChangelogFunctions;
+
+declare const getDependencyReleaseLine: _changesets_types.GetDependencyReleaseLine;
+declare const getReleaseLine: _changesets_types.GetReleaseLine;
+
+export { changelogFunctions as default, getDependencyReleaseLine, getReleaseLine };

package/dist/index.mjs

@@ -0,0 +1,170 @@
+// src/index.ts
+import { getInfo, getInfoFromPullRequest } from "@changesets/get-github-info";
+import { config as loadEnv } from "dotenv";
+loadEnv();
+var releaseTypeMap = {
+  major: { icon: "\u{1F680}", label: "Major" },
+  minor: { icon: "\u2728", label: "Minor" },
+  patch: { icon: "\u{1F41B}", label: "Patch" },
+  none: { icon: "\u{1F4DD}", label: "Update" }
+};
+function resolveReleaseType(type) {
+  if (type && type in releaseTypeMap) {
+    return type;
+  }
+  return "none";
+}
+function assertRepo(options) {
+  if (!options || !options.repo) {
+    throw new Error(
+      'Please provide a repo to this changelog generator like this:\n"changelog": ["@icebreakers/changelog-github", { "repo": "org/repo" }]'
+    );
+  }
+}
+async function collectDependencyReferences(changesets, repo) {
+  const references = await Promise.all(
+    changesets.map(async (cs) => {
+      if (!cs.commit) {
+        return null;
+      }
+      const { links } = await getInfo({
+        repo,
+        commit: cs.commit
+      });
+      return links.commit;
+    })
+  );
+  return references.filter((link) => Boolean(link));
+}
+function formatDependencyLine(references, dependenciesUpdated) {
+  const dependencySummaries = dependenciesUpdated.map(
+    (dependency) => `\`${dependency.name}\` @ ${dependency.newVersion}`
+  );
+  const segments = [];
+  if (dependencySummaries.length > 0) {
+    segments.push(dependencySummaries.join(", "));
+  }
+  if (references.length > 0) {
+    segments.push(references.join(" \xB7 "));
+  }
+  const details = segments.join(" \xB7 ");
+  return details.length > 0 ? `- \u{1F4E6} Updated dependencies: ${details}` : "- \u{1F4E6} Updated dependencies";
+}
+function parseSummary(summary) {
+  let prNumber;
+  let commitRef;
+  const users = [];
+  const cleanedSummary = summary.replace(/^\s*(?:pr|pull|pull\s+request):\s*#?(\d+)/im, (_, pr) => {
+    const num = Number(pr);
+    if (!Number.isNaN(num)) {
+      prNumber = num;
+    }
+    return "";
+  }).replace(/^\s*commit:\s*(\S+)/im, (_, commit) => {
+    commitRef = commit;
+    return "";
+  }).replace(/^\s*(?:author|user):\s*@?(\S+)/gim, (_, user) => {
+    users.push(user);
+    return "";
+  }).trim();
+  const [headline = "", ...restLines] = cleanedSummary.split("\n").map((line) => line.trimRight());
+  const detailLines = restLines.map((line) => line.trim()).map((line) => line.replace(/^\s*[-*]\s*/, "")).filter((line) => line.length > 0);
+  return {
+    headline,
+    detailLines,
+    prNumber,
+    commitRef,
+    users
+  };
+}
+async function resolveLinks(repo, parsed, changesetCommit) {
+  if (parsed.prNumber !== void 0) {
+    const { links } = await getInfoFromPullRequest({
+      repo,
+      pull: parsed.prNumber
+    });
+    if (parsed.commitRef) {
+      const shortCommitId = parsed.commitRef.slice(0, 7);
+      links.commit = `[\`${shortCommitId}\`](https://github.com/${repo}/commit/${parsed.commitRef})`;
+    }
+    return links;
+  }
+  const commitToUse = parsed.commitRef ?? changesetCommit;
+  if (commitToUse) {
+    const { links } = await getInfo({
+      repo,
+      commit: commitToUse
+    });
+    return links;
+  }
+  return {
+    commit: null,
+    pull: null,
+    user: null
+  };
+}
+function buildUserMentions(users, fallbackUser) {
+  if (users.length > 0) {
+    return users.map((username) => `[@${username}](https://github.com/${username})`).join(", ");
+  }
+  return fallbackUser ?? "";
+}
+var changelogFunctions = {
+  async getDependencyReleaseLine(changesets, dependenciesUpdated, options) {
+    assertRepo(options);
+    const { repo } = options;
+    if (dependenciesUpdated.length === 0) {
+      return "";
+    }
+    const references = await collectDependencyReferences(
+      changesets,
+      repo
+    );
+    return formatDependencyLine(references, dependenciesUpdated);
+  },
+  async getReleaseLine(changeset, type, options) {
+    assertRepo(options);
+    const { repo } = options;
+    const parsedSummary = parseSummary(changeset.summary);
+    const resolvedType = resolveReleaseType(type);
+    const links = await resolveLinks(
+      repo,
+      parsedSummary,
+      changeset.commit
+    );
+    const userMentions = buildUserMentions(
+      parsedSummary.users,
+      links.user
+    );
+    const headlineText = parsedSummary.headline || "Miscellaneous improvements";
+    const detailText = parsedSummary.detailLines.join(" \xB7 ");
+    const metaSegments = [];
+    if (links.pull) {
+      metaSegments.push(links.pull);
+    }
+    if (links.commit) {
+      metaSegments.push(links.commit);
+    }
+    if (userMentions) {
+      metaSegments.push(`Thanks ${userMentions}`);
+    }
+    if (resolvedType !== "none") {
+      metaSegments.push(`${releaseTypeMap[resolvedType].label} release`);
+    }
+    const trailingSegments = [
+      detailText,
+      metaSegments.join(" \xB7 ")
+    ].filter((segment) => segment.length > 0);
+    const suffix = trailingSegments.length ? ` \u2014 ${trailingSegments.join(" \xB7 ")}` : "";
+    return `
+
+- ${releaseTypeMap[resolvedType].icon} **${headlineText}**${suffix}`;
+  }
+};
+var index_default = changelogFunctions;
+var { getDependencyReleaseLine, getReleaseLine } = changelogFunctions;
+export {
+  index_default as default,
+  getDependencyReleaseLine,
+  getReleaseLine
+};

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@icebreakers/changelog-github",
+  "type": "module",
+  "version": "0.0.1",
+  "description": "Changesets GitHub changelog formatter for Icebreaker's dev-configs",
+  "author": "ice breaker <1324318532@qq.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sonofmagic/dev-configs.git",
+    "directory": "packages/changelog-github"
+  },
+  "bugs": {
+    "url": "https://github.com/sonofmagic/dev-configs/issues"
+  },
+  "keywords": [
+    "changesets",
+    "changelog",
+    "dev-configs",
+    "icebreakers"
+  ],
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@changesets/get-github-info": "^0.6.0",
+    "@changesets/types": "^6.1.0",
+    "dotenv": "^17.2.3"
+  },
+  "devDependencies": {
+    "@changesets/parse": "^0.4.1"
+  },
+  "scripts": {
+    "stub": "unbuild --stub",
+    "dev": "tsup --watch --sourcemap",
+    "build": "tsup",
+    "test": "vitest run",
+    "test:dev": "vitest",
+    "release": "pnpm publish",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix"
+  }
+}