soulcraft/brainy
2
0
Fork 0
Code Issues 1 Pull requests Projects Releases 335 Packages Wiki Activity Actions

**chore(version): bump version to 0.9.30 and enhance publishing instructions**

Browse source 
- Updated version to `0.9.30` in `package.json`, `cli-package/package.json`, `src/utils/version.ts`, and `README.md`.
- Synced `@soulcraft/brainy` dependency version to `0.9.30` for CLI package consistency.
- Modified npm version badge in `README.md` to reflect the new version.
- Added detailed publishing instructions in `docs/publishing-cli.md` to guide users on publishing both, main, or CLI packages.
- Introduced new npm scripts `publish:cli` and `build:cli` for streamlined package-specific operations.

This update ensures cohesive versioning, provides clearer publishing guidelines, and improves maintainability with new build/publish scripts.
This commit is contained in:
David Snelling 2025-07-02 16:33:30 -07:00
parent ccd59eaacf
commit cf18cd99c4
7 changed files with 64 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

55
docs/publishing-cli.md
View file

@ -26,10 +26,14 @@ cd /path/to/brainy
git pull
```
### 3. Build and publish both packages
### 3. Build and publish packages
You have three options for publishing:
#### Option A: Publish both packages together
```bash
npm run deploy:both
npm run publish:both
```
This command will:
@ -40,6 +44,27 @@ This command will:
- 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:
@ -51,15 +76,33 @@ npm view @soulcraft/brainy-cli
## How It Works
The publishing process uses the `scripts/publish-cli.js` script, which:
### 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. Builds the CLI with `npm run build:cli`
4. Verifies the CLI was built successfully
5. Publishes the main package with `npm publish` from the root directory
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)