data-schema

Shared data schema for TOBL projects

Introduction

This repository contains the shared data schema used across multiple TOBL projects. It is published as an NPM package for easy consumption.

Installation

To install this package, run the following command:

yarn add tobl-data-schema

Publishing a New Version

To publish a new version of this package, follow these steps:

1. Navigate to the project directory:

   cd path/to/tobl-data-schema

2. Run the publish command:

   yarn publish

   This will prompt you to enter the new version number. After confirming, it will automatically build and publish the package.

3. Confirm the publish:

   You should see a success message indicating that the package has been published.

Upgrading the Package in Other Projects

In tobl-functions-ts Project

1. Navigate to the project directory:

   cd path/to/tobl-functions-ts

2. Run the upgrade command:

   yarn upgrade tobl-data-schema --latest

In tobl-web Project

1. Navigate to the project directory:

   cd path/to/tobl-web

2. Run the upgrade command:

   yarn upgrade tobl-data-schema --latest 

Contributing

Please read the CONTRIBUTING.md for details on how to contribute to this project.