From 4562d3a96709034e9a5f59fbba82c368eb9ff7c5 Mon Sep 17 00:00:00 2001 From: Alex Yang Date: Sun, 4 Feb 2024 17:37:10 -0600 Subject: [PATCH] docs: update CONTRIBUTING.md --- CONTRIBUTING.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 568d125efd..aef70263fb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -78,3 +78,33 @@ pnpm start That should start a webserver which will serve the docs on https://localhost:3000 Any changes you make should be reflected in the browser. If you need to regenerate the API docs and find that your TSDoc isn't getting the updates, feel free to remove apps/docs/api. It will automatically regenerate itself when you run pnpm start again. + +## Publishing + +To publish a new version of the library, run + +```shell +pnpm release # will run the build command, run the tests, and create a new version commit +pnpm new-llamaindex # only release the llamaindex package +pnpm new-create-llama # only release the create-llama package +``` + +### Release `llamaindex` + +```shell +cd packages/core/dist +pnpm publish +``` + +### Release `create-llama` + +```shell +cd packages/create-llama +pnpm publish +``` + +### Push new changes to the repository + +```shell +git push +```