svelte-rtf-editor 0.1.0 → 1.0.0

package/README.md

@@ -196,6 +196,64 @@ The components use CSS custom properties with sensible fallbacks, so they work o
 
 ---
 
+## Contributing & releasing
+
+This project uses [Changesets](https://github.com/changesets/changesets) for versioning and changelog generation.
+
+### Making changes
+
+After making code changes, describe them with a changeset:
+
+```bash
+npm run changeset
+# → interactive prompt: pick patch / minor / major, write a short description
+```
+
+Commit both your code and the generated `.changeset/*.md` file together.
+
+### Publishing a new version
+
+When ready to cut a release:
+
+```bash
+# 1. Consume pending changesets — bumps package.json and updates CHANGELOG.md
+npm run version
+
+# 2. Commit the version bump
+git add .
+git commit -m "chore: release v$(node -p "require('./package.json').version")"
+git push
+
+# 3. Create a GitHub release — this triggers CI to build and publish to npm
+VERSION=$(node -p "require('./package.json').version")
+gh release create "v$VERSION" --title "v$VERSION" --generate-notes
+```
+
+Requires the [GitHub CLI](https://cli.github.com/) (`brew install gh`, then `gh auth login` once).
+The `--generate-notes` flag has GitHub auto-generate release notes from commits since the last tag.
+
+### Version bump rules
+
+| Change type | Bump |
+|---|---|
+| Bug fix | `patch` — 0.1.0 → 0.1.1 |
+| New feature (backwards compatible) | `minor` — 0.1.0 → 0.2.0 |
+| Breaking change | `major` — 0.1.0 → 1.0.0 |
+
+### First-time npm publish
+
+The npm Trusted Publisher (OIDC) setup requires the package to exist on npm before it can be configured. For the very first publish, run locally:
+
+```bash
+npm login
+npm run prepack
+npm publish --access public
+```
+
+Then go to `npmjs.com/package/svelte-rtf-editor` → **Settings** → **Trusted Publishers** and add the GitHub Actions publisher pointing at this repo's `publish.yml`. All subsequent releases will go through CI automatically.
+
+---
+
 ## Local development
 
 Clone this repo and link it to your project for instant iteration without publishing:

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "svelte-rtf-editor",
-	"version": "0.1.0",
+	"version": "1.0.0",
 	"description": "RTF viewer and rich-text editor components for Svelte 5",
 	"license": "MIT",
 	"homepage": "https://github.com/jfc76/svelte-rtf-editor#readme",
@@ -16,7 +16,10 @@
 		"prepare": "svelte-kit sync || echo ''",
 		"prepack": "svelte-kit sync && svelte-package && publint",
 		"check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
-		"check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch"
+		"check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
+		"changeset": "changeset",
+		"version": "changeset version",
+		"release": "npm run prepack && changeset publish"
 	},
 	"files": [
 		"dist",
@@ -39,6 +42,7 @@
 		"svelte": "^5.0.0"
 	},
 	"devDependencies": {
+		"@changesets/cli": "^2.30.0",
 		"@sveltejs/adapter-auto": "^7.0.0",
 		"@sveltejs/kit": "^2.50.2",
 		"@sveltejs/package": "^2.5.7",