Skip to content

Commit d734408

Browse files
committed
docs: add release process and common issues to README
1 parent 655bc1b commit d734408

1 file changed

Lines changed: 50 additions & 0 deletions

File tree

README.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -240,6 +240,56 @@ The app uses a modern purple color scheme inspired by the Arkade brand:
240240
- **pnpm** - Fast, disk space efficient package manager
241241

242242

243+
## Release Process
244+
245+
To publish a new version of the snap to npm:
246+
247+
### 1. Bump Version
248+
249+
```bash
250+
# Navigate to the snap package
251+
cd packages/snap
252+
253+
# Bump version (patch, minor, or major)
254+
npm version patch # or minor/major
255+
```
256+
257+
### 2. Rebuild Snap
258+
259+
After bumping the version, you must rebuild the snap to update the `snap.manifest.json` with the new version and shasum:
260+
261+
```bash
262+
pnpm run build
263+
```
264+
265+
This command will automatically:
266+
267+
- Update the version in `snap.manifest.json` to match `package.json`
268+
- Regenerate the shasum for the new bundle
269+
270+
### 3. Commit Changes
271+
272+
```bash
273+
git add .
274+
git commit -m "chore: bump version to x.x.x"
275+
git push
276+
```
277+
278+
### 4. Publish to npm
279+
280+
```bash
281+
# Make sure you're logged in to npm
282+
npm whoami
283+
284+
# Publish the package
285+
npm publish
286+
```
287+
288+
### Common Issues
289+
290+
- **Shasum mismatch error**: Always run `pnpm run build` after changing the version number
291+
- **Version mismatch**: The build command automatically syncs versions between `package.json` and `snap.manifest.json`
292+
243293
## Contributing
244294

245295
Contributions are welcome! Please feel free to submit a Pull Request.

0 commit comments

Comments
 (0)