David Snelling
1539ba74de
- Deleted the following obsolete files: - `CHANGES.md`, `changes-summary.md`, `CHANGES_SUMMARY.md`: Contained redundant or outdated change logs and implementation summaries. - `COMPATIBILITY.md`: Detailed compatibility behavior no longer relevant after environment detection updates. - `fix-documentation.md`: Addressed a resolved issue regarding `process.memoryUsage` errors in testing. - `DIMENSION_MISMATCH_SUMMARY.md`: Provided a legacy summary of resolved embedding dimension mismatch issues. - `demo.md`: Documented an outdated demo process for testing Brainy features. - `CONCURRENCY_IMPLEMENTATION_SUMMARY.md`: Summarized already-documented concurrency features. - `IMPLEMENTATION_SUMMARY.md`: Detailed an obsolete implementation of optional model bundling. - Purpose: - Streamline and declutter archive by removing redundant or outdated documentation. - Align repository with current feature set and documentation standards.
134 lines
3.6 KiB
Markdown
134 lines
3.6 KiB
Markdown
# Publishing @soulcraft/brainy and @soulcraft/brainy-cli to npm
|
|
|
|
This document explains how to publish both the @soulcraft/brainy and @soulcraft/brainy-cli packages to npm.
|
|
|
|
## Prerequisites
|
|
|
|
Before publishing, ensure you have:
|
|
|
|
1. Node.js >= 24.4.0 installed
|
|
2. An npm account with access to the @soulcraft organization
|
|
3. Logged in to npm using `npm login`
|
|
|
|
## Publishing Process
|
|
|
|
The repository is set up to publish both packages together with synchronized versions. To publish the packages, follow
|
|
these steps:
|
|
|
|
### 1. Ensure you're in the root directory of the project
|
|
|
|
```bash
|
|
cd /path/to/brainy
|
|
```
|
|
|
|
### 2. Make sure you have the latest version of the code
|
|
|
|
```bash
|
|
git pull
|
|
```
|
|
|
|
### 3. Build and publish packages
|
|
|
|
You have three options for publishing:
|
|
|
|
#### Option A: Publish both packages together
|
|
|
|
```bash
|
|
npm run publish:both
|
|
```
|
|
|
|
This command will:
|
|
|
|
- Ensure versions are in sync between both packages
|
|
- Build the main package
|
|
- Build the CLI
|
|
- Verify the CLI was built successfully
|
|
- Publish the main package to npm
|
|
- Publish the CLI package to npm
|
|
|
|
#### Option B: Publish only the main package
|
|
|
|
```bash
|
|
npm run publish
|
|
```
|
|
|
|
This command will:
|
|
|
|
- Build the main package
|
|
- Publish the main package to npm
|
|
|
|
#### Option C: Publish only the CLI package
|
|
|
|
```bash
|
|
npm run publish:cli
|
|
```
|
|
|
|
This command will:
|
|
|
|
- Ensure versions are in sync
|
|
- Build the CLI package
|
|
- Publish the CLI package to npm
|
|
|
|
### 4. Verify the packages were published successfully
|
|
|
|
After publishing, you can verify that the packages were published successfully by checking the npm registry:
|
|
|
|
```bash
|
|
npm view @soulcraft/brainy
|
|
npm view @soulcraft/brainy-cli
|
|
```
|
|
|
|
## How It Works
|
|
|
|
### Publishing Both Packages
|
|
|
|
The `publish:both` command uses the `scripts/publish-cli.js` script, which:
|
|
|
|
1. Ensures versions are in sync by running `scripts/generate-version.js`
|
|
2. Builds the main package with `npm run build`
|
|
3. Publishes the main package with `npm publish` from the root directory
|
|
4. Builds the CLI package with `npm run build` in the cli-package directory
|
|
5. Verifies the CLI was built successfully
|
|
6. Publishes the CLI package with `npm publish` from the cli-package directory
|
|
|
|
### Publishing Only the Main Package
|
|
|
|
The `publish` command:
|
|
|
|
1. Builds the main package with `npm run build`
|
|
2. Publishes the main package with `npm publish` from the root directory
|
|
|
|
### Publishing Only the CLI Package
|
|
|
|
The `publish:cli` command:
|
|
|
|
1. Ensures versions are in sync by running `scripts/generate-version.js`
|
|
2. Changes to the cli-package directory
|
|
3. Builds the CLI package with `npm run build`
|
|
4. Publishes the CLI package with `npm publish`
|
|
|
|
The version synchronization ensures that:
|
|
|
|
- Both packages always have the same version number
|
|
- The CLI package's dependency on the main package is exact (not using the ^ prefix)
|
|
- The README.md file is updated with the current version
|
|
|
|
The CLI package is configured in `cli-package/package.json` with:
|
|
|
|
- The correct package name: `@soulcraft/brainy-cli`
|
|
- `"private": false` to allow publishing
|
|
- `"publishConfig": { "access": "public" }` to ensure the scoped package is public
|
|
- The necessary files in the `"files"` array
|
|
- The correct bin configuration to make the CLI available as `brainy`
|
|
|
|
## Troubleshooting
|
|
|
|
If you encounter any issues during the publishing process:
|
|
|
|
1. Make sure you're logged in to npm with an account that has access to the @soulcraft organization
|
|
2. Ensure that the `dist/cli.js` file exists and has been built correctly
|
|
3. If you get an error about the package already existing, you may need to update the version in both package.json
|
|
files:
|
|
```bash
|
|
npm version patch # This will update both package.json files via the version script
|
|
```
|