@revisiononline/contracts

This package contains shared contracts (interfaces, enums, DTOs) used across the Revision Online platform.

Manual Publishing for Developers

Note: The CI/CD pipeline is the official method for publishing this package. The manual publishing method described below is provided as a convenience for developers during development and testing.

If you need to quickly publish changes without waiting for the CI/CD pipeline, you can use the manual publishing tool.

Prerequisites

1. Make sure you have npm access to the @revisiononline organization
2. Log in to npm using npm login

Manual Publishing Steps

1. Make your changes to the contracts
2. Run the manual publish script:

# Run the script directly
./manual-publish.sh

# or use the npm script
npm run manual-publish

The script will:

1. Check if you're logged in to npm
2. Fetch the latest version from npm registry (just like the pipeline does)
3. Calculate the next patch version
4. Create a temporary copy of your code with the updated version
5. Build the package in the temporary directory
6. Publish to npm
7. Clean up the temporary directory

Note: This script does not modify your local package.json file. The version in your local package.json remains unchanged, while the correct incremented version is published to npm.

How It Works

The script:

1. Creates a temporary directory
2. Copies all your files there
3. Updates only the temporary package.json with the correct version
4. Builds and publishes from that directory
5. Cleans up afterward

This approach ensures your local development files remain unchanged while still publishing with the correct version number.

After Publishing

After publishing, you can update the dependency in your projects:

npm install @revisiononline/contracts@latest