Skip to content

Commit c27b2fa

Browse files
committed
minor process updates
1 parent 6906856 commit c27b2fa

File tree

1 file changed

+29
-28
lines changed

1 file changed

+29
-28
lines changed

RELEASES.md

Lines changed: 29 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,17 @@
33
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
44
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
55

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

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

@@ -30,8 +31,9 @@
3031

3132
### Browser Test
3233

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

3638
### Node Test
3739

@@ -46,14 +48,13 @@ $ npm run demo-text
4648
$ npm run demo-stream
4749
```
4850

49-
### React/TypeScript Test
51+
### React/TypeScript
52+
53+
Test
5054

5155
1. Ensure newest `dist/pptxgen.es.js` and `types/index.d.ts` under local node_modules
52-
2. Note: Any updates to `node_modules/dist/pptxgen.es.js` are not picked up by the server (ctrl-C and restart)
53-
3. Update `demos/react-demo/package.json` version
54-
4. Open `demos/react-demo/src/tstest/Test.tsx`
55-
5. Check existing code
56-
6. Test defs by using auto-complete, "pptxgen.ChartType." etc.
56+
2. Update `demos/react-demo/package.json` version
57+
3. Open `demos/react-demo/src/tstest/Test.tsx`, check for typescript errors/warnings: use auto-complete, "pptxgen.ChartType." etc.
5758

5859
```bash
5960
$ cd ~/GitHub/PptxGenJS/demos/react-demo
@@ -64,28 +65,28 @@ $ npm run start
6465
2. Go to http://192.168.1.x:3000 on iPhone, run demo tests
6566
3. Go to http://192.168.1.x:3000 on Android, run demo tests
6667
4. Open exports on each device to ensure MIME type is correct, looks right, etc.
68+
5. Note: Any updates to `node_modules/dist/pptxgen.es.js` are not picked up by the server (ctrl-C and restart)
6769

68-
```bash
69-
$ cd ~/GitHub/PptxGenJS/demos/react-demo
70-
$ npm run build
71-
```
70+
Build
7271

73-
1. Copy entire "build" folder to Downloads for subsequently updating gh-pages with latest build
74-
2. Note: **DO NOT** use the deploy script offered onscreen!
72+
1. Run `~/GitHub/PptxGenJS/demos/react-demo/npm run build`
73+
2. Copy entire "build" folder to Downloads for subsequently updating gh-pages with latest build
74+
3. Note: **DO NOT** use the deploy script offered onscreen!
7575

7676
## Release New Version
7777

7878
### Pre-Release Check
7979

80-
1. Update `demos/browser/index.html` head to use "RELEASE (CDN)"
81-
2. Is version updated in package.json and src/pptxgen.ts?
82-
3. Are `index.d.ts` defs updated?
80+
1. Update: `demos/browser/index.html` head to use "RELEASE (CDN)"
81+
2. Check: Is `version` updated in package.json?
82+
3. Check: Is `version` updated in src/pptxgen.ts?
83+
4. Check: Is `types/index.d.ts` file updated?
8384

8485
### GitHub
8586

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

9192
### NPM

0 commit comments

Comments
 (0)