From f1d333c6d9c2e9f8b86fc88cfb075dcdaa05d86b Mon Sep 17 00:00:00 2001 From: 10Derozan Date: Wed, 31 Jan 2024 18:59:38 +0800 Subject: [PATCH] docs(module-tools): add slot for release npm in monorepo (#5345) --- .../module-doc/docs/en/components/publish-emo.mdx | 0 .../{publish-your-project.md => publish-your-project.mdx} | 8 +++++++- .../module-doc/docs/zh/components/publish-emo.mdx | 0 .../{publish-your-project.md => publish-your-project.mdx} | 8 +++++++- 4 files changed, 14 insertions(+), 2 deletions(-) create mode 100644 packages/document/module-doc/docs/en/components/publish-emo.mdx rename packages/document/module-doc/docs/en/guide/basic/{publish-your-project.md => publish-your-project.mdx} (90%) create mode 100644 packages/document/module-doc/docs/zh/components/publish-emo.mdx rename packages/document/module-doc/docs/zh/guide/basic/{publish-your-project.md => publish-your-project.mdx} (90%) diff --git a/packages/document/module-doc/docs/en/components/publish-emo.mdx b/packages/document/module-doc/docs/en/components/publish-emo.mdx new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/packages/document/module-doc/docs/en/guide/basic/publish-your-project.md b/packages/document/module-doc/docs/en/guide/basic/publish-your-project.mdx similarity index 90% rename from packages/document/module-doc/docs/en/guide/basic/publish-your-project.md rename to packages/document/module-doc/docs/en/guide/basic/publish-your-project.mdx index a2e623a880b6..ca739676b189 100644 --- a/packages/document/module-doc/docs/en/guide/basic/publish-your-project.md +++ b/packages/document/module-doc/docs/en/guide/basic/publish-your-project.mdx @@ -7,7 +7,13 @@ sidebar_position: 7 An npm-type module project release process consists of two phases. - The first phase is during development, where the developer needs to provide a change file to record changes that need to be released. -- The second phase is during release, where Modern.js Module can collect all the change files to update the version, update the release log, and release new packages to the [npm Registry](https://www.npmjs.com/). +- The second phase is during release, collect all the change files to update the version, update the release log, and release new packages to the [npm Registry](https://www.npmjs.com/). + +Modern.js Module provides a set of version management and release solutions, which are suitable for single-package scenarios. For npm packages in monorepo, you need to follow the strategies provided by various monorepo solutions. + +import PublishEMO from '@site-docs/components/publish-emo'; + + ## Tracking changes diff --git a/packages/document/module-doc/docs/zh/components/publish-emo.mdx b/packages/document/module-doc/docs/zh/components/publish-emo.mdx new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/packages/document/module-doc/docs/zh/guide/basic/publish-your-project.md b/packages/document/module-doc/docs/zh/guide/basic/publish-your-project.mdx similarity index 90% rename from packages/document/module-doc/docs/zh/guide/basic/publish-your-project.md rename to packages/document/module-doc/docs/zh/guide/basic/publish-your-project.mdx index 9651be8ada4a..8ba60703c376 100644 --- a/packages/document/module-doc/docs/zh/guide/basic/publish-your-project.md +++ b/packages/document/module-doc/docs/zh/guide/basic/publish-your-project.mdx @@ -7,7 +7,13 @@ sidebar_position: 7 一个 npm 类型的模块项目发布流程包含了两个阶段： - 第一阶段是在开发期间，开发者需要提供变更文件，该文件记录了在发布期间需要的变更内容； -- 第二阶段是在发布期间，Modern.js Module 会收集所有的变更文件来更新版本、更新发布日志，并发布新的包到 [npm Registry](https://www.npmjs.com/) 上。 +- 第二阶段是在发布期间，需要收集所有的变更文件来更新版本、更新发布日志，并发布新的包到 [npm Registry](https://www.npmjs.com/) 上。 + +Modern.js Module 提供了一套版本管理与发布的方案，这适用于单包场景。对于 monorepo 里的 npm 包你需要遵循各类 monorepo 解决方案提供的策略。 + +import PublishEMO from '@site-docs/components/publish-emo'; + + ## 跟踪变更