Skip to content

Commit 2c95441

Browse files
davidlehndlongley
authored andcommitted
Move Bower/bundle support to forge-dist.
- Keep main repo as CommonJS code without accumulated large built bundles. - Remove bower.json. - Update README. - Update CONTRIBUTING release instructions.
1 parent 8854c1c commit 2c95441

File tree

4 files changed

+40
-19
lines changed

4 files changed

+40
-19
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ Forge ChangeLog
1616
- Improve OID mapping code.
1717
- Change test servers from Python to JavaScript.
1818
- Improve PhantomJS support.
19+
- Move Bower/bundle support to
20+
[forge-dist](https://github.com/digitalbazaar/forge-dist).
1921

2022
### Added
2123

CONTRIBUTING.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@ Versioning
2020
Release Process
2121
---------------
2222

23-
* commit changes
23+
## Update the main repository:
24+
25+
* Commit changes.
2426
* `$EDITOR package.json`: update to release version and remove `-dev` suffix.
2527
* `git commit package.json -m "Release {version}."`
2628
* `git tag {version}`
@@ -29,12 +31,32 @@ Release Process
2931
* `git push`
3032
* `git push --tags`
3133

34+
## Publish to NPM:
35+
3236
To ensure a clean upload, use a clean updated checkout, and run the following:
3337

3438
* `git checkout {version}`
3539
* `npm publish`
3640

41+
## Update bundled distribution
42+
43+
This is kept in a different repository due to accumulated per-release bundle
44+
sizes.
45+
46+
* Checkout [forge-dist][].
47+
* Build a clean Forge version you want to distribute:
48+
* `git checkout {version}`
49+
* `npm run build`
50+
* Copy files to `forge-dist`:
51+
* `cp FORGE/dist/forge.min.js FORGE/dist/jsbn.min.js FORGEDIST/dist/`
52+
* Release `forge-dist`:
53+
* Commit changes.
54+
* `git tag {version}`
55+
* `git push`
56+
* `git push --tags`
57+
3758
[Node.js Style Guide]: http://nodeguide.com/style.html
38-
[jshint]: http://www.jshint.com/install/
39-
[Semantic Versioning]: http://semver.org/
4059
[README]: ./README.md
60+
[Semantic Versioning]: http://semver.org/
61+
[forge-dist]: https://github.com/digitalbazaar/forge-dist
62+
[jshint]: http://www.jshint.com/install/

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,18 @@ You can then use forge as a regular module:
110110
var forge = require('node-forge');
111111
```
112112

113+
### Bundle / Bower
114+
115+
Pre-built and minimized basic forge bundles are built in the [UMD][] format for
116+
each release and distributed in a separate repository:
117+
118+
https://github.com/digitalbazaar/forge-dist
119+
120+
This bundle can be used in many environments. In particular it can be installed
121+
with [Bower][]:
122+
123+
bower install forge
124+
113125
### Requirements
114126

115127
The core JavaScript has the following requirements:
@@ -1896,6 +1908,7 @@ Financial support is welcome and helps contribute to futher development:
18961908
[SHA-384]: http://en.wikipedia.org/wiki/SHA-384
18971909
[SHA-512]: http://en.wikipedia.org/wiki/SHA-512
18981910
[TLS]: http://en.wikipedia.org/wiki/Transport_Layer_Security
1911+
[UMD]: https://github.com/umdjs/umd
18991912
[X.509]: http://en.wikipedia.org/wiki/X.509
19001913
[freenode]: https://freenode.net/
19011914
[webpack]: https://webpack.github.io/

bower.json

Lines changed: 0 additions & 16 deletions
This file was deleted.

0 commit comments

Comments
 (0)