RELEASING.md

Release Process

This document describes the process used to release a new version of pdf-lib. It serves as a useful reference for maintainers when they release a new version. Users and contributors may also find it useful to understand the process.

Checklist

1. Run git checkout master && git pull
2. Update version number in package.json
3. Run rm -rf node_modules && yarn install
4. Run yarn release:prep
5. Run integration tests:
   • Run yarn apps:node 'Preview'
   • Run yarn apps:node 'Adobe Acrobat'
   • Run yarn apps:deno 'Foxit Reader'
   • Run yarn apps:web:mac and test in Firefox
   • Run yarn apps:web:mac and test in Chrome
   • Run yarn apps:web:mac and test in Safari
   • Run yarn apps:rn:ios
   • Run yarn apps:rn:android
6. Run git commit -am 'Bump version to X.Y.Z'
7. Run yarn release:next or yarn release:latest
8. If you used release:latest:
   • Edit the release notes
   • Attach the release's .tgz