From 251be60630f96510ddc3971eeeb2e5458b077b67 Mon Sep 17 00:00:00 2001 From: Felix Roos Date: Thu, 23 Mar 2023 11:39:33 +0100 Subject: [PATCH] update package publishing guide --- CONTRIBUTING.md | 9 ++++++++- website/src/pages/technical-manual/packages.mdx | 5 +++-- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fe1108978..a0e9770fb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -123,7 +123,14 @@ To publish all packages that have been changed since the last release, run: ```sh npm login -npx lerna publish + +# this will increment all the versions in package.json files of non private packages to selected versions +npx lerna version --no-private + +# publish all packages inside /packages using pnpm! don't use lerna to publish!! +pnpm --filter "./packages/**" publish --dry-run + +# the last command was only a dry-run, make sure everything looks ok, if yes, run the same command without flag ``` To manually publish a single package, increase the version in the `package.json`, then run `pnpm publish`. diff --git a/website/src/pages/technical-manual/packages.mdx b/website/src/pages/technical-manual/packages.mdx index 9efd351b6..e17265a8a 100644 --- a/website/src/pages/technical-manual/packages.mdx +++ b/website/src/pages/technical-manual/packages.mdx @@ -58,5 +58,6 @@ These packages provide bindings for different ways to output strudel patterns: ## Tools -- [pnpm workspaces](https://pnpm.io/) -- Publishing packages is done with [lerna](https://lerna.js.org/). +- [pnpm](https://pnpm.io/) for package management, workspaces and publishing +- [lerna](https://lerna.js.org/) for bumping versions +- see CONTRIBUTING.md for more info