Skip to content

fix: 完善开源文档与 npm 发布流程 - #11

Merged
bosens-China merged 1 commit into
masterfrom
agent/open-source-docs-npm-release
Jul 28, 2026
Merged

fix: 完善开源文档与 npm 发布流程#11
bosens-China merged 1 commit into
masterfrom
agent/open-source-docs-npm-release

Conversation

@bosens-China

Copy link
Copy Markdown
Member

改动内容

  • 将项目整理为 pnpm monorepo,拆分插件包与 Rspress 文档站
  • 补充快速开始、默认启用规则、Node.js API 和 npm 包内 README
  • 补齐贡献指南、行为准则、安全策略、支持说明、Issue 表单和 PR 模板
  • 修复 pnpm 生命周期与 prepack 冲突,恢复 npm pack --dry-run
  • 使用 npm Trusted Publishing 所需的 OIDC 权限,固定 GitHub Actions 到完整 SHA
  • 补充 ESM/CommonJS 条件入口、公开发布配置和 Release Please manifest
  • 纳入项目级中文写作、分步提交和 npm 发布技能

原因

现有 v1.0.2 只创建了 GitHub Release,没有发布到 npm;旧发布流程依赖长期 token,当前迁移状态还存在打包失败、文档入口不足和社区协作文件缺失等问题。本次改动统一修复发布链路,并让默认配置的开箱即用行为在文档中清晰可见。

用户与开发者影响

用户只需安装插件并在 Prettier 中启用,即可使用全部 16 条可自动修复的默认规则。维护者可通过 Release Please 和 npm OIDC 发布后续版本;npm Trusted Publisher 与 GitHub Pages 仍需在账户侧完成一次配置。

验证

  • pnpm check
  • 17 个测试全部通过
  • 插件与文档生产构建通过
  • npm pack --dry-run --json
  • ESM 与 CommonJS 根入口加载验证

@bosens-China
bosens-China marked this pull request as ready for review July 28, 2026 06:12
@bosens-China
bosens-China merged commit cc4ffc1 into master Jul 28, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant