72 lines (54 loc) · 1.48 KB

Publishing Guide for TopLocs Plugin SDK

Prerequisites

Ensure you have npm access to publish under the @toplocs scope
Login to npm: npm login
Verify access: npm whoami

Publishing Steps

Ensure clean working directory
```
git status
```
Update version in package.json
```
npm version patch  # or minor/major
```
Build the package
```
npm run build
```

Test the package locally

npm pack
# This creates toplocs-plugin-sdk-1.0.0.tgz
# Test in another project: npm install path/to/toplocs-plugin-sdk-1.0.0.tgz

Publish to npm
```
npm publish
```
Push tags to GitHub
```
git push origin main --tags
```
Create GitHub Release
- Go to https://github.com/toplocs/plugin-sdk/releases
- Click "Create a new release"
- Select the version tag
- Add release notes from CHANGELOG.md

First-time Setup

If this is the first publish:

# Ensure you're logged in
npm login

# Publish with public access
npm publish --access public

Version Guidelines

Patch (1.0.x): Bug fixes, documentation updates
Minor (1.x.0): New features, backwards compatible
Major (x.0.0): Breaking changes

Post-publish Checklist

Package visible on https://www.npmjs.com/package/@toplocs/plugin-sdk
Installation works: npm install @toplocs/plugin-sdk
Update documentation if needed
Announce in project channels