Skip to content

Latest commit

聽

History

History
63 lines (42 loc) 路 1.47 KB

CONTRIBUTING.md

File metadata and controls

63 lines (42 loc) 路 1.47 KB
Raw

Contributing

Development

This repository is broken into different packages

  • /langfuse-core > All common code goes here.
  • /langfuse-node > Node.js specific code
  • /langfuse > Web/Edge/modern Node.js specific code, using fetch and browser APIs
  • /langfuse-langchain > Langchain integration via callback handler

Installing dependencies

yarn

Running tests

yarn test

Integration test

Setup

  1. Start local langfuse server
  2. Create testing project
  3. Set environment: LANGFUSE_BASEURL, LANGFUSE_PUBLIC_KEY, LANGFUSE_SECRET_KEY

Run

# Build SDKs
yarn build

# Run E2E test
yarn test:integration

Update OpenAPI spec

  1. Generate Fern JavaScript SDK in langfuse and copy the files generated in web/public/generated/api/openapi.yml and web/public/generated/api-client/openapi.yml into the langfuse-core/openapi-spec folder in this repo.
  2. Execute the following command: yarn run generateAPI

Publishing a new version

git clean -fdx -e node_modules -e .env
yarn
yarn build

Run npx lerna publish --force-publish --no-private

  • Bumps version number of langfuse and langfuse-node, ignores langfuse-core
  • Publishes to NPM, publishes also when there are no changes to keep the version numbers in sync
  • Confirm with npmjs OTP

Alpha: npx lerna publish prerelease --force-publish --no-private --dist-tag alpha --preid alpha

Write release notes in GitHub releases.