Skip to content

Commit

Permalink
minor process updates
Browse files Browse the repository at this point in the history
  • Loading branch information
gitbrent committed May 2, 2021
1 parent 6906856 commit c27b2fa
Showing 1 changed file with 29 additions and 28 deletions.
57 changes: 29 additions & 28 deletions RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,17 @@
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

- [Build Library, Update Files](#build-library-update-files)
- [Test Newest Library Build](#test-newest-library-build)
- [Browser](#browser)
- [Node](#node)
- [React/TypeScript](#reacttypescript)
- [Release New Version](#release-new-version)
- [Pre-Release Check](#pre-release-check)
- [GitHub](#github)
- [NPM](#npm)
- [Post-Release Tasks](#post-release-tasks)
- [PptxGenJS Release Checklist](#pptxgenjs-release-checklist)
- [Build Library, Update Files](#build-library-update-files)
- [Run Platform Tests](#run-platform-tests)
- [Browser Test](#browser-test)
- [Node Test](#node-test)
- [React/TypeScript](#reacttypescript)
- [Release New Version](#release-new-version)
- [Pre-Release Check](#pre-release-check)
- [GitHub](#github)
- [NPM](#npm)
- [Post-Release Tasks](#post-release-tasks)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

Expand All @@ -30,8 +31,9 @@

### Browser Test

1. Ensure newest `pptxgen.bundle.js` is loaded using F12 > Sources tab
2. Run all tests in browser [Demo Page](file:///Users/brentely/GitHub/PptxGenJS/demos/browser/index.html)
1. Run `~/GitHub/PptxGenJS/demos/node browser_server.mjs`
2. Ensure newest `pptxgen.bundle.js` is loaded using F12 > Sources tab
3. Run all tests in browser [Demo Page](file:///Users/brentely/GitHub/PptxGenJS/demos/browser/index.html)

### Node Test

Expand All @@ -46,14 +48,13 @@ $ npm run demo-text
$ npm run demo-stream
```

### React/TypeScript Test
### 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.
2. Update `demos/react-demo/package.json` version
3. Open `demos/react-demo/src/tstest/Test.tsx`, check for typescript errors/warnings: use auto-complete, "pptxgen.ChartType." etc.

```bash
$ cd ~/GitHub/PptxGenJS/demos/react-demo
Expand All @@ -64,28 +65,28 @@ $ npm run start
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.
5. Note: Any updates to `node_modules/dist/pptxgen.es.js` are not picked up by the server (ctrl-C and restart)

```bash
$ cd ~/GitHub/PptxGenJS/demos/react-demo
$ npm run build
```
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!
1. Run `~/GitHub/PptxGenJS/demos/react-demo/npm run build`
2. Copy entire "build" folder to Downloads for subsequently updating gh-pages with latest build
3. 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?
1. Update: `demos/browser/index.html` head to use "RELEASE (CDN)"
2. Check: Is `version` updated in package.json?
3. Check: Is `version` updated in src/pptxgen.ts?
4. Check: Is `types/index.d.ts` file updated?

### GitHub

1. Checkin all changes via GitHub Desktop
2. Copy CHANGELOG entry and draft new release: [Releases](https://github.com/gitbrent/PptxGenJS/releases)
3. Use "Version X.x.x" as title and "v3.1.1" as tag
3. Use "Version X.x.x" as title and "v3.6.0" as tag
4. Go back to Releases page, double-check title/tag, release when ready

### NPM
Expand Down

0 comments on commit c27b2fa

Please sign in to comment.