@peiyanlu/release 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) $YEAR $OWNER
+
+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,111 @@
+# Release Project
+
+<p>
+  <a href="https://www.npmjs.com/package/@peiyanlu/create-release" target="_blank">
+    <img src="https://img.shields.io/badge/npm-@peiyanlu/create--release-blue.svg?logo=npm" alt="NPM Package" />
+  </a>
+  <a href="https://www.npmjs.com/package/@peiyanlu/create-release" target="_blank">
+    <img src="https://img.shields.io/npm/v/@peiyanlu/create-release.svg" alt="NPM Version" />
+  </a>
+  <a href="https://www.npmjs.com/package/@peiyanlu/create-release" target="_blank">
+    <img src="https://img.shields.io/npm/l/@peiyanlu/create-release.svg" alt="Package License" />
+  </a>
+  <a href="https://www.npmjs.com/package/@peiyanlu/create-release" target="_blank">
+    <img src="https://img.shields.io/npm/dm/@peiyanlu/create-release.svg" alt="NPM Downloads" />
+  </a>
+</p>
+
+
+🚀 Generic CLI tool to automate versioning and package publishing
+
+- Bump version (in e.g. `package.json`)
+- [Git commit, tag, push][1]
+- [Create release at GitHub][3]
+- [Generate changelog][5]
+- [Publish to npm][6]
+
+## Installation
+
+```bash
+npm install -D @peiyanlu/release
+
+yarn add -D @peiyanlu/release
+
+pnpm add -D @peiyanlu/release
+```
+
+## Configuration
+
+发布流程可以通过配置文件进行自定义。如果项目中没有提供配置文件，工具会自动使用内置的默认配置，配置文件可以是以下文件之一：`release.config.{ts,mts,cts,js,mjs,cjs}`
+
+```ts
+// release.config.ts
+import { defineConfig } from '@peiyanlu/release'
+
+
+export default defineConfig({
+  git: {
+    commitMessage: 'chore(release): ${version}',
+    tagName: '${version}',
+  },
+  npm: {
+    publish: true,
+  },
+  github: {
+    release: true,
+    autoGenerate: true,
+  },
+})
+
+```
+
+## Git
+
+
+将 **暂存（stage）→ 提交（commit）→ 打标签（tag）→ 推送（push）** 这些发布步骤自动化，并支持推送到 **任意 Git 远程仓库**。
+
+
+## npmjs.com Releases
+
+
+截至 **2025 年 7 月**，GitHub CI 工作流现在可以使用 npm 的 **[Trusted Publishing（可信发布）][30]** 的 **OpenID Connect（OIDC）** 集成，从 CI/CD 中实现**安全、无 Token 的发布**。
+这将不再需要长期有效的访问令牌（long-lived tokens），并且会**自动生成来源证明（provenance attestations）**。
+
+
+## GitHub Releases
+
+GitHub 项目可以将 **Release** 附加到 **Git 标签（Tag）** 上，其中包含 **发布说明（release notes）** 和 **构建产物（assets）**。
+在你的发布流程中，有两种方式可以创建 **GitHub Releases**：
+
+1. **自动化方式**（需要提供 `GITHUB_TOKEN`）
+2. **手动方式**（通过 GitHub 网页界面，使用预先填充好的字段来创建）
+
+## Changelog
+
+通过读取 Git 提交历史（`git log`） 自动生成 Changelog
+
+```bash
+git log --pretty=format:"%s %h %H" {from}...{to}
+```
+
+## Publish to npm
+
+通过读取 `package.json` 中的 `publishConfig` 配置发布到 npm 仓库
+
+
+## Dry Runs
+
+使用 `--dry-run` 可以展示整个交互流程，以及工具原本将要执行的所有命令，但不会真正执行任何操作。
+
+
+[1]: #git
+
+[3]: #github-releases
+
+[5]: #changelog
+
+[6]: #publish-to-npm
+
+[30]: https://docs.npmjs.com/trusted-publishers
+
+[32]: https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases