Skip to content

Commit 5f8d5c2

Browse files
committed
Update docs.
- Update to v1.0.0. - Update changelog. - Update release details. - Remove mentions of bower and forge-dist. - Rename master to main. - Add Libera.Chat IRC channel. - Minor other fixes.
1 parent 27286fe commit 5f8d5c2

File tree

4 files changed

+34
-95
lines changed

4 files changed

+34
-95
lines changed

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
*.py[co]
22
*.sw[nop]
33
*~
4-
.bower.json
54
.cdtproject
65
.classpath
76
.cproject

CHANGELOG.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,15 @@
11
Forge ChangeLog
22
===============
33

4-
## 0.11.0 - 2021-xx-xx
4+
## 1.0.0 - 2022-xx-xx
5+
6+
### Notes
7+
- **1.0.0**!
8+
- This project is over a decade old! Time for a 1.0.0 release.
9+
- The URL related changes may expose bugs in some of the networking related
10+
code (unrelated to the much wider used cryptography code). The automated and
11+
manual test coverage for this code is weak at best. Issues or patches to
12+
update the code or tests would be appreciated.
513

614
### Removed
715
- **SECURITY**, **BREAKING**: Remove `forge.debug` API. The API has the
@@ -27,6 +35,12 @@ Forge ChangeLog
2735

2836
### Changed
2937
- **BREAKING**: Increase supported Node.js version to 6.13.0 for URL support.
38+
- **BREAKING**: Renamed `master` branch to `main`.
39+
- **BREAKING**: Release process updated to use tooling that prefixes versions
40+
with `v`. Other tools, scripts, or scanners may need to adapt.
41+
- **BREAKING**: Remove docs related to Bower and
42+
[forge-dist](https://github.com/digitalbazaar/forge-dist). Use [NPM][] or
43+
another CDN. (Also be sure to read "Security Considerations" in the README.)
3044

3145
### Added
3246
- OIDs for `surname`, `title`, and `givenName`.
@@ -36,12 +50,6 @@ Forge ChangeLog
3650
Depending on how applications used this id to name association it could cause
3751
compatibility issues.
3852

39-
### Notes
40-
- The URL related changes may expose bugs in some of the networking related
41-
code (unrelated to the much wider used cryptography code). The automated and
42-
manual test coverage for this code is weak at best. Issues or patches to
43-
update the code or tests would be appreciated.
44-
4553
## 0.10.0 - 2020-09-01
4654

4755
### Changed

README.md

Lines changed: 9 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ not be regularly updated.
105105

106106
If you want to use forge with [Node.js][], it is available through `npm`:
107107

108-
https://npmjs.org/package/node-forge
108+
https://www.npmjs.com/package/node-forge
109109

110110
Installation:
111111

@@ -120,32 +120,20 @@ var forge = require('node-forge');
120120
The npm package includes pre-built `forge.min.js`, `forge.all.min.js`, and
121121
`prime.worker.min.js` using the [UMD][] format.
122122

123-
### Bundle / Bower
124-
125-
Each release is published in a separate repository as pre-built and minimized
126-
basic forge bundles using the [UMD][] format.
127-
128-
https://github.com/digitalbazaar/forge-dist
129-
130-
This bundle can be used in many environments. In particular it can be installed
131-
with [Bower][]:
132-
133-
bower install forge
134-
135123
### jsDelivr CDN
136124

137125
To use it via [jsDelivr](https://www.jsdelivr.com/package/npm/node-forge) include this in your html:
138126

139127
```html
140-
<script src="https://cdn.jsdelivr.net/npm/node-forge@0.7.0/dist/forge.min.js"></script>
128+
<script src="https://cdn.jsdelivr.net/npm/node-forge@1.0.0/dist/forge.min.js"></script>
141129
```
142130

143131
### unpkg CDN
144132

145133
To use it via [unpkg](https://unpkg.com/#/) include this in your html:
146134

147135
```html
148-
<script src="https://unpkg.com/node-forge@0.7.0/dist/forge.min.js"></script>
136+
<script src="https://unpkg.com/node-forge@1.0.0/dist/forge.min.js"></script>
149137
```
150138

151139
### Development Requirements
@@ -2003,8 +1991,8 @@ When using this code please keep the following in mind:
20031991
runtime characteristics, runtime optimization, code optimization, code
20041992
minimization, code obfuscation, bundling tools, possible bugs, the Forge code
20051993
itself, and so on.
2006-
- If using pre-built bundles from [Bower][] or similar be aware someone else
2007-
ran the tools to create those files.
1994+
- If using pre-built bundles from [NPM][], another CDN, or similar, be aware
1995+
someone else ran the tools to create those files.
20081996
- Use a secure transport channel such as [TLS][] to load scripts and consider
20091997
using additional security mechanisms such as [Subresource Integrity][] script
20101998
attributes.
@@ -2030,7 +2018,8 @@ Contact
20302018
* Code: https://github.com/digitalbazaar/forge
20312019
* Bugs: https://github.com/digitalbazaar/forge/issues
20322020
* Email: support@digitalbazaar.com
2033-
* IRC: [#forgejs][] on [freenode][]
2021+
* IRC: [#forgejs][] on [Libera.Chat][] (people may also be on [freenode][] for
2022+
historical reasons).
20342023

20352024
Donations
20362025
---------
@@ -2045,7 +2034,6 @@ Financial support is welcome and helps contribute to futher development:
20452034
[3DES]: https://en.wikipedia.org/wiki/Triple_DES
20462035
[AES]: https://en.wikipedia.org/wiki/Advanced_Encryption_Standard
20472036
[ASN.1]: https://en.wikipedia.org/wiki/ASN.1
2048-
[Bower]: https://bower.io/
20492037
[Browserify]: http://browserify.org/
20502038
[CBC]: https://en.wikipedia.org/wiki/Block_cipher_mode_of_operation
20512039
[CFB]: https://en.wikipedia.org/wiki/Block_cipher_mode_of_operation
@@ -2058,7 +2046,9 @@ Financial support is welcome and helps contribute to futher development:
20582046
[HMAC]: https://en.wikipedia.org/wiki/HMAC
20592047
[JavaScript]: https://en.wikipedia.org/wiki/JavaScript
20602048
[Karma]: https://karma-runner.github.io/
2049+
[Libera.Chat]: https://libera.chat/
20612050
[MD5]: https://en.wikipedia.org/wiki/MD5
2051+
[NPM]: https://www.npmjs.com/
20622052
[Node.js]: https://nodejs.org/
20632053
[OFB]: https://en.wikipedia.org/wiki/Block_cipher_mode_of_operation
20642054
[PKCS#10]: https://en.wikipedia.org/wiki/Certificate_signing_request

RELEASE.md

Lines changed: 10 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,19 @@
11
Forge Release Process
22
=====================
33

4-
Versioning
5-
----------
4+
Prepare a Release
5+
-----------------
66

77
* Follow the [Semantic Versioning][] guidelines.
8-
* Use version X.Y.Z-dev in dev mode.
9-
* Use version X.Y.Z for releases.
10-
11-
Master Branch Release Process
12-
-----------------------------
13-
148
* Ensure [tests pass](./README.md#testing).
9+
* Ensure [CHANGELOG.md](./CHANGELOG.md) is up-to-date using [Keep a
10+
CHANGELOG][] style.
1511

16-
## Update the main repository:
17-
18-
* Commit changes.
19-
* Update the [CHANGELOG](./CHANGELOG.md) as needed using rougly
20-
[Keep a CHANGELOG][] style.
21-
* `$EDITOR package.json`: update to release version and remove `-dev` suffix.
22-
* `git commit package.json -m "Release {version}."`
23-
* `git tag {version}`
24-
* `$EDITOR package.json`: update to next version and add `-dev` suffix.
25-
* `git commit package.json -m "Start {next-version}."`
26-
* `git push`
27-
* `git push --tags`
28-
29-
## Publish to NPM:
30-
31-
To ensure a clean upload, use a clean updated checkout, and run the following:
32-
33-
* `git checkout {version}`
34-
* `npm install`
35-
* `npm publish`
36-
37-
## Update bundled distribution
38-
39-
This is kept in a different repository to avoid the accumulated size when
40-
adding per-release bundles.
41-
42-
* Checkout [forge-dist][].
43-
* Build a clean Forge version you want to distribute:
44-
* `git checkout {version}`
45-
* `npm install`
46-
* `npm run build`
47-
* Copy files to `forge-dist`:
48-
* `cp dist/forge.min.js{,.map} dist/prime.worker.min.js{,.map} FORGEDIST/dist/`
49-
* Release `forge-dist`:
50-
* `git commit -a -m "Release {version}."`
51-
* `git tag {version}`
52-
* `git push`
53-
* `git push origin {version}`
54-
55-
Older Branch Release Process
56-
----------------------------
57-
58-
In order to provide support for Bower (and similar) for current built bundle
59-
releases and historical releases the [forge-dist][] repository needs to be
60-
updated with code changes and tags from the main repository. Once a historical
61-
branch, like 0.6.x, on the main repository is updated and tagged, do the
62-
following:
12+
Publish to NPM
13+
--------------
6314

64-
* Checkout [forge-dist][].
65-
* Setup an upstream branch:
66-
* `git remote add upstream git@github.com:digitalbazaar/forge.git`
67-
* `git fetch upstream`
68-
* Merge changes:
69-
* `git checkout 0.6.x`
70-
* `git merge upstream/0.6.x`
71-
* Push code and tag(s):
72-
* `git push`
73-
* `git push origin {version}`
15+
As of Forge 1.0.0 publishing is performed using the `pubnpm` script from
16+
https://github.com/digitalbazaar/publish-script.
7417

75-
[Keep a CHANGELOG]: http://keepachangelog.com/
76-
[Semantic Versioning]: http://semver.org/
77-
[forge-dist]: https://github.com/digitalbazaar/forge-dist
18+
[Keep a CHANGELOG]: https://keepachangelog.com/
19+
[Semantic Versioning]: https://semver.org/

0 commit comments

Comments
 (0)