Skip to content

Repository files navigation

OneSchema logo

OneSchema SDK

This repository contains tools to help you embed OneSchema products into your application.

OneSchema Importer

OneSchema FileFeeds (legacy)

The FileFeeds packages are in maintenance mode. They keep working and still receive critical and security fixes, but no new features and no major updates are planned.

Development

See TESTING.md for how to run and test the SDK packages locally.

Releasing

Add a changeset in your pull request when changing a published package. Merging the Version Packages pull request updates package versions and publishes them.

The legacy FileFeeds packages are ignored by that automation: do not write a changeset for them, and note the change under Unreleased in CHANGELOG-filefeeds.md instead. Their versions and their publish are handled by hand, only when a maintenance fix warrants a release.

The workflow publishes through npm's trusted publishing: every package is registered on npm with a GitHub Actions trusted publisher for oneschema/sdk and the release.yml workflow in the release environment, so authentication and provenance both come from the workflow's OIDC identity and no npm token is involved. The environment is restricted to main, which is what keeps a rewritten workflow on another branch from publishing. A new package has to be registered the same way before its first automated publish — org oneschema, repository sdk, workflow release.yml, environment release, allowed action npm publish.

Every published package is tagged <package>@<version> on the commit it was built from, and the release workflow then compares each tarball on npm with a fresh build of that commit, so a release can always be traced back to its source. To repeat that comparison later, run the Verify release workflow on the tag, or locally:

git checkout @oneschema/importer@0.7.6
yarn install --immutable && yarn build
node scripts/verify-published.mjs

About

Tools for embedding OneSchema into your application

Topics

Resources

Contributing

Stars

22 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages