From 3c715ac729908ef633a435bfd3e7f6323a5fd6a1 Mon Sep 17 00:00:00 2001 From: Daniel Roe Date: Mon, 23 Jan 2023 16:53:59 +0000 Subject: [PATCH] chore: include central readme/licence when publishing individual packages (#18421) --- .gitignore | 2 + .../5.community/5.framework-contribution.md | 48 +++++++++++++++++++ packages/kit/README.md | 5 -- packages/nuxi/README.md | 5 -- packages/nuxt/README.md | 5 -- packages/schema/README.md | 3 -- packages/test-utils/README.md | 3 -- packages/vite/README.md | 5 -- packages/webpack/README.md | 5 -- scripts/release-edge.sh | 2 + scripts/release-rc.sh | 2 + scripts/release.sh | 2 + 12 files changed, 56 insertions(+), 31 deletions(-) delete mode 100644 packages/kit/README.md delete mode 100644 packages/nuxi/README.md delete mode 100644 packages/nuxt/README.md delete mode 100644 packages/schema/README.md delete mode 100644 packages/test-utils/README.md delete mode 100644 packages/vite/README.md delete mode 100644 packages/webpack/README.md diff --git a/.gitignore b/.gitignore index 1efebd2cb2..ffd4e5fb1f 100644 --- a/.gitignore +++ b/.gitignore @@ -3,6 +3,8 @@ node_modules jspm_packages package-lock.json +packages/*/README.md +packages/*/LICENSE */**/yarn.lock /.yarn diff --git a/docs/content/1.docs/5.community/5.framework-contribution.md b/docs/content/1.docs/5.community/5.framework-contribution.md index 9508356a17..ec83f1ac5d 100644 --- a/docs/content/1.docs/5.community/5.framework-contribution.md +++ b/docs/content/1.docs/5.community/5.framework-contribution.md @@ -7,6 +7,54 @@ description: Some specific points about contributions to the nuxt/nuxt repositor Once you've read the [general contribution guide](/docs/community/contribution), here are some specific points to make about contributions to the `nuxt/nuxt` repository. +## Monorepo Guide + +### `packages/kit` + +> Toolkit for authoring Nuxt Modules + +- Published as: `@nuxt/kit` +- [Learn more about this package](/docs/guide/going-further/kit). + +### `packages/nuxi` + +> Nuxt Command Line Interface + +- Published as: `nuxi` +- [Learn more about this package](/docs/api/commands/add). + +### `packages/nuxt` + +> The core of Nuxt 3 + +- Published as: `nuxt` + +### `packages/schema` + +> Cross-version Nuxt typedefs and defaults + +- Published as: `@nuxt/schema` + +### `packages/test-utils` + +> Test utilities for Nuxt. + +- Published as: `@nuxt/test-utils` + +### `packages/vite` + +> The [Vite](https://vitejs.dev) bundler for Nuxt 3. + +- Published as: `@nuxt/vite-builder` +- [Learn more about this package](/docs/api/configuration/nuxt-config#vite). + +### `packages/webpack` + +> The [webpack](https://webpack.js.org) bundler for Nuxt 3 + +- Published as: `@nuxt/webpack-builder` +- [Learn more about this package](/docs/api/configuration/nuxt-config#webpack-1). + ## Using the Playground While working on a PR, you will likely want to check if your changes are working correctly. diff --git a/packages/kit/README.md b/packages/kit/README.md deleted file mode 100644 index 728b6153e4..0000000000 --- a/packages/kit/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# Nuxt Kit - -> Toolkit for authoring Nuxt Modules - -Learn more about this package: diff --git a/packages/nuxi/README.md b/packages/nuxi/README.md deleted file mode 100644 index 55c959cbcc..0000000000 --- a/packages/nuxi/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# Nuxi - -> Nuxt Command Line Interface - -Learn more about this package: diff --git a/packages/nuxt/README.md b/packages/nuxt/README.md deleted file mode 100644 index 1b8b39d932..0000000000 --- a/packages/nuxt/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# Nuxt 3 - -> The core of Nuxt 3 - -Learn more about this package: diff --git a/packages/schema/README.md b/packages/schema/README.md deleted file mode 100644 index efddf36d9e..0000000000 --- a/packages/schema/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# Nuxt Schema - -> Cross-version Nuxt typedefs and defaults diff --git a/packages/test-utils/README.md b/packages/test-utils/README.md deleted file mode 100644 index fec2807b96..0000000000 --- a/packages/test-utils/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# Nuxt Test Utils - -Test utilities for Nuxt. diff --git a/packages/vite/README.md b/packages/vite/README.md deleted file mode 100644 index bc8e76b41f..0000000000 --- a/packages/vite/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# Nuxt Vite Builder - -> [Vite](https://vitejs.dev) bundler for Nuxt 3. - -Learn more about this package: diff --git a/packages/webpack/README.md b/packages/webpack/README.md deleted file mode 100644 index f695b5d08f..0000000000 --- a/packages/webpack/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# Nuxt Webpack Builder - -> The [Webpack](https://webpack.js.org) bundler for Nuxt 3 - -Learn more about this package: diff --git a/scripts/release-edge.sh b/scripts/release-edge.sh index e8639c7aad..9ed577ad47 100755 --- a/scripts/release-edge.sh +++ b/scripts/release-edge.sh @@ -20,6 +20,8 @@ fi for p in packages/* ; do pushd $p echo "Publishing $p" + cp ../../LICENSE . + cp ../../README.md . pnpm publish --access public --no-git-checks popd done diff --git a/scripts/release-rc.sh b/scripts/release-rc.sh index 751bed5375..d362b2a4b1 100755 --- a/scripts/release-rc.sh +++ b/scripts/release-rc.sh @@ -16,6 +16,8 @@ for PKG in packages/* ; do TAG="rc" fi echo "⚡ Publishing $PKG with tag $TAG" + cp ../../LICENSE . + cp ../../README.md . pnpm publish --access public --no-git-checks --tag $TAG popd > /dev/null done diff --git a/scripts/release.sh b/scripts/release.sh index 299c0f414e..47e082fe5e 100755 --- a/scripts/release.sh +++ b/scripts/release.sh @@ -13,6 +13,8 @@ for PKG in packages/* ; do pushd $PKG TAG="latest" echo "⚡ Publishing $PKG with tag $TAG" + cp ../../LICENSE . + cp ../../README.md . pnpm publish --access public --no-git-checks --tag $TAG popd > /dev/null done