Skip to content

RELEASES.md

Latest commit

 

History

History
104 lines (78 loc) · 3.16 KB

RELEASES.md

File metadata and controls

104 lines (78 loc) · 3.16 KB

PptxGenJS Release Checklist

Build Library, Update Files

  1. Update package.json version
  2. Update src/pptxgen.ts version (eg: const VERSION = '3.3.1')
  3. Update CHANGELOG.md with new date
  4. Update README.md with new CDN links
  5. Build library: npm scripts > ship
  6. Consolidate new changes from src/bld/*.ts into types/index.d.ts and update version in head comment
  7. Open dist/*.js and check headers

Run Platform Tests

Browser Test

  1. Ensure newest pptxgen.bundle.js is loaded using F12 > Sources tab
  2. Run all tests in browser Demo Page

Node Test

  1. Update demos/node/package.json version
  2. Run various tests
$ cd ~/GitHub/PptxGenJS/demos/node
$ npm run demo
$ npm run demo-all
$ npm run demo-text
$ npm run demo-stream

React/TypeScript Test

  1. Ensure newest dist/pptxgen.es.js and types/index.d.ts under local node_modules
  2. Note: Any updates to node_modules/dist/pptxgen.es.js are not picked up by the server (ctrl-C and restart)
  3. Update demos/react-demo/package.json version
  4. Open demos/react-demo/src/tstest/Test.tsx
  5. Check existing code
  6. Test defs by using auto-complete, "pptxgen.ChartType." etc.
$ cd ~/GitHub/PptxGenJS/demos/react-demo
$ npm run start
  1. Go to React Test on iMac, run demo tests
  2. Go to http://192.168.1.x:3000 on iPhone, run demo tests
  3. Go to http://192.168.1.x:3000 on Android, run demo tests
  4. Open exports on each device to ensure MIME type is correct, looks right, etc.
$ cd ~/GitHub/PptxGenJS/demos/react-demo
$ npm run build
  1. Copy entire "build" folder to Downloads for subsequently updating gh-pages with latest build
  2. Note: DO NOT use the deploy script offered onscreen!

Release New Version

Pre-Release Check

  1. Update demos/browser/index.html head to use "RELEASE (CDN)"
  2. Is version updated in package.json and src/pptxgen.ts?
  3. Are index.d.ts defs updated?

GitHub

  1. Checkin all changes via GitHub Desktop
  2. Copy CHANGELOG entry and draft new release: Releases
  3. Use "Version X.x.x" as title and "v3.1.1" as tag
  4. Go back to Releases page, double-check title/tag, release when ready

NPM

$ cd ~/GitHub/PptxGenJS
$ npm publish

Post-Release Tasks

  1. Test CDN links on README.md
  2. Load gh-pages branch
  3. Update installation.md with latest CDN version
  4. Copy contents of the newest "build" folder (from above) into ./demo-react folder
  5. Update API documentation if needed