Proposal for 4.0.0 Release

[lholmquist]

I noticed that we have a 3.2.0 release, but the package.json is still at 3.1.0. I think we did that release in a separate branch for some reason, but the list of commits below were generated with git log v3.1.0..upstream/main --oneline and the "Changelog section" was generated from npm run release -- --dry-run

There are some spots in the code that say "remove in 4.0", should we remove those things now before this release?

8205bc9 (HEAD -> main, upstream/main, origin/main) chore(package): Upgrade mocha from 7.1.2 to 8.2.0 (#354)
765b81c chore: tag v3.2.0 as release-v3.2.0 for release-please (#353)
c4afacb chore(ci,releases): bump release-please-action to 2.5.5 (#350)
f6be285 fix: extend Node.js IncomingHttpHeaders in our Headers type (#346)
1446898 fix: do not alter an event's data attribute (#344)
138de37 docs: update README with latest API changes (#347)
76688c4 chore: update release please to the latest release(2.4.1) (#345)
e334b6e feat: add emitterFactory and friends (#342)
a9114b7 chore: add an automated GH action for releases (#329)
eca43d9 fix: package.json & package-lock.json to reduce vulnerabilities (#338)
0a12146 docs: update README with maintainer names (#337)
1fa3a05 (remove-gts-from-ts-example) feat: add a constructor parameter for loose validation (#328)
7423acb fix: upgrade cloudevents from 3.0.1 to 3.1.0 (#335)
4779d89 chore(example): Replaced body parser with express JSON parser (#334)
6cd310c src(event)!: make the event's time property only a string (#330)
f3953a9 (lance/v3.2.x-backport, develop) feat: introduce Message, Serializer, Deserializer and Binding interfaces (#324)
17d4bc8 chore: add cucumber.js to list of files to lint and /docs to .gitignore (#327)
73f0bec chore: Update README with correct links for the support specification versions (#321)
0adcc35 chore: Remove commented version import. (#319)
6e2390e fix: upgrade uuid from 8.2.0 to 8.3.0 (#317)
4bf2eb8 chore: Update references of master to main (#316)
b5cf886 test: implement pending tests leftover from TS rewrite (#315)
8ac3eb0 refactor: validate cloudevent version agnostic (#311)
81623ac chore: typo (#313)
b3624c2 docs: add ref to CoC and other things (#244)

Change Log

4.0.0 (2020-10-26)

⚠ BREAKING CHANGES

• event: make the event's time property only a string (src(event)!: make the event's time property only a string #330)

Features

• add a constructor parameter for loose validation (#328) (1fa3a05)
• add emitterFactory and friends (#342) (e334b6e)
• introduce Message, Serializer, Deserializer and Binding interfaces (#324) (f3953a9)

Bug Fixes

• do not alter an event's data attribute (#344) (1446898)
• extend Node.js IncomingHttpHeaders in our Headers type (#346) (f6be285)
• package.json & package-lock.json to reduce vulnerabilities (#338) (eca43d9)
• upgrade cloudevents from 3.0.1 to 3.1.0 (#335) (7423acb)
• upgrade uuid from 8.2.0 to 8.3.0 (#317) (6e2390e)

Tests

• implement pending tests leftover from TS rewrite (#315) (b5cf886)

Documentation

• add ref to CoC and other things (#244) (b3624c2)
• update README with latest API changes (#347) (138de37)
• update README with maintainer names (#337) (0a12146)

Miscellaneous

• package: Upgrade mocha from 7.1.2 to 8.2.0 (#354) (8205bc9)
• tag v3.2.0 as release-v3.2.0 for release-please (#353) (765b81c)
• ci,releases: bump release-please-action to 2.5.5 (#350) (c4afacb)
• add an automated GH action for releases (#329) (a9114b7)
• Remove commented version import. (#319) (0adcc35)
• typo (#313) (81623ac)
• Update README with correct links for the support specification versions (#321) (73f0bec), closes #320
• update release please to the latest release(2.4.1) (#345) (76688c4)
• event: make the event's time property only a string (#330) (6cd310c)
• example: Replaced body parser with express JSON parser (#334) (4779d89)
• add cucumber.js to list of files to lint and /docs to .gitignore (#327) (17d4bc8)
• Update references of master to main (#316) (4bf2eb8)
• validate cloudevent version agnostic (#311) (8ac3eb0)

[lholmquist]

@cloudevents/sdk-javascript-maintainers ^^

[grant]

The default branch has 3.1, but the v3.x branch has 3.2. So it's a bit weird seeing 3.2 out, yes.

I'm fine keeping the default branch up-to-date with whatever is published on npm (or a little ahead, but having github behind a bit weird imo).

[lholmquist]

i feel like we were going to release a 4.0 when we did the 3.2.0, but then we got delayed, so things got a little weird. but i can't remember that exactly.

but anyway, the 4.0 release notes will have commits that are in the 3.2.0 release, and i think that is ok, since it is just documentation

[lance]

i feel like we were going to release a 4.0 when we did the 3.2.0, but then we got delayed, so things got a little weird. but i can't remember that exactly.

There were a couple of issues that we wanted to definitively land in 4.0.0. IIRC

• Bug: time attribute is always a string, yet is type casted to string | Date #326 - done
• Should throw if specversion attribute is missing #332 - this is still open but we closed src(receiver): don't default specversion on receiving if there isn't one. #349 without merging. Not sure what we want to do here
• const enums not supported in some transpilers #323 - I think we should address this issue

but anyway, the 4.0 release notes will have commits that are in the 3.2.0 release, and i think that is ok, since it is just documentation

WFM

[lholmquist]

This #362 should also be merged first as well as #363

[github-actions]

This issue is stale because it has been open 30 days with no activity.

[lance]

@lholmquist what do you say? About ready for that 4.0.0 release? (I could use it for boson).

[lholmquist]

@lance sorry, some other things have gotten in the way. I'll review what we have left today.

[lholmquist]

There are 2 issues that were mentioned that have not yet been fixed, but I think they could be done in a follow up 4.0.1

#332
#323

Also the distributed tracing issue, #355 can be taken care of in a patch release

@lance if it is ok with you, I think we can do this release. The PR, #368 , that release-please created is pretty close, but doesn't include all these changelog entries. I can update that PR manually, then merge it. And hopefully it "fixes" our issues with the automation for next time

Below is the updated list of commits and changelog:

d656362 (HEAD -> main, upstream/main, origin/main) build(deps): bump highlight.js from 10.3.2 to 10.4.1 (#372)
79296a8 chore: add a transition guide. fixes #360 (#363)
9f86cfd fix: improve error messages when validating extensions
132f052 fix: package.json & package-lock.json to reduce vulnerabilities
6adb578 ci: disable @typescript-eslint/no-explicit-any linter rule
43d9e01 feat: allow ensureDelivery to be able to ensure delivery on emit
d418a50 ci: add unit test for emitter
bda8581 docs: add Emitter logic example
25f9c48 feat: add EventEmitter to Emitter and singleton paradigm
875f700 feat!: Remove All API's that are labeled "Remove in 4.0" (#362)
8205bc9 chore(package): Upgrade mocha from 7.1.2 to 8.2.0 (#354)
765b81c chore: tag v3.2.0 as release-v3.2.0 for release-please (#353)
c4afacb chore(ci,releases): bump release-please-action to 2.5.5 (#350)
f6be285 fix: extend Node.js IncomingHttpHeaders in our Headers type (#346)
1446898 fix: do not alter an event's data attribute (#344)
138de37 docs: update README with latest API changes (#347)
76688c4 chore: update release please to the latest release(2.4.1) (#345)
e334b6e feat: add emitterFactory and friends (#342)
a9114b7 chore: add an automated GH action for releases (#329)
eca43d9 fix: package.json & package-lock.json to reduce vulnerabilities (#338)
0a12146 docs: update README with maintainer names (#337)
1fa3a05 (remove-gts-from-ts-example) feat: add a constructor parameter for loose validation (#328)
7423acb fix: upgrade cloudevents from 3.0.1 to 3.1.0 (#335)
4779d89 chore(example): Replaced body parser with express JSON parser (#334)
6cd310c src(event)!: make the event's time property only a string (#330)
f3953a9 (lance/v3.2.x-backport, develop) feat: introduce Message, Serializer, Deserializer and Binding interfaces (#324)
17d4bc8 chore: add cucumber.js to list of files to lint and /docs to .gitignore (#327)
73f0bec chore: Update README with correct links for the support specification versions (#321)
0adcc35 chore: Remove commented version import. (#319)
6e2390e fix: upgrade uuid from 8.2.0 to 8.3.0 (#317)
4bf2eb8 chore: Update references of master to main (#316)
b5cf886 test: implement pending tests leftover from TS rewrite (#315)
8ac3eb0 refactor: validate cloudevent version agnostic (#311)
81623ac chore: typo (#313)
b3624c2 docs: add ref to CoC and other things (#244)

4.0.0 (2020-12-10)

⚠ BREAKING CHANGES

• Remove All API's that are labeled "Remove in 4.0" (Remove All API's that are labeled "Remove in 4.0" #362)
• event: make the event's time property only a string (src(event)!: make the event's time property only a string #330)

Features

• add a constructor parameter for loose validation (#328) (1fa3a05)
• add emitterFactory and friends (#342) (e334b6e)
• add EventEmitter to Emitter and singleton paradigm (25f9c48)
• allow ensureDelivery to be able to ensure delivery on emit (43d9e01)
• introduce Message, Serializer, Deserializer and Binding interfaces (#324) (f3953a9)
• Remove All API's that are labeled "Remove in 4.0" (#362) (875f700)

Bug Fixes

• do not alter an event's data attribute (#344) (1446898)
• extend Node.js IncomingHttpHeaders in our Headers type (#346) (f6be285)
• improve error messages when validating extensions (9f86cfd)
• package.json & package-lock.json to reduce vulnerabilities (132f052)
• package.json & package-lock.json to reduce vulnerabilities (#338) (eca43d9)
• upgrade cloudevents from 3.0.1 to 3.1.0 (#335) (7423acb)
• upgrade uuid from 8.2.0 to 8.3.0 (#317) (6e2390e)

Tests

• implement pending tests leftover from TS rewrite (#315) (b5cf886)

Documentation

• add Emitter logic example (bda8581)
• add ref to CoC and other things (#244) (b3624c2)
• update README with latest API changes (#347) (138de37)
• update README with maintainer names (#337) (0a12146)

Miscellaneous

• add a transition guide. fixes #360 (#363) (79296a8)
• package: Upgrade mocha from 7.1.2 to 8.2.0 (#354) (8205bc9)
• add an automated GH action for releases (#329) (a9114b7)
• tag v3.2.0 as release-v3.2.0 for release-please (#353) (765b81c)
• ci,releases: bump release-please-action to 2.5.5 (#350) (c4afacb)
• Remove commented version import. (#319) (0adcc35)
• typo (#313) (81623ac)
• update release please to the latest release(2.4.1) (#345) (76688c4)
• event: make the event's time property only a string (#330) (6cd310c)
• example: Replaced body parser with express JSON parser (#334) (4779d89)
• add cucumber.js to list of files to lint and /docs to .gitignore (#327) (17d4bc8)
• Update README with correct links for the support specification versions (#321) (73f0bec), closes #320
• Update references of master to main (#316) (4bf2eb8)
• validate cloudevent version agnostic (#311) (8ac3eb0)

[lance]

There are 2 issues that were mentioned that have not yet been fixed, but I think they could be done in a follow up 4.0.1

Agree that these two and #355 can be a part of 4.x.y

[lholmquist]

Version 4.0.0 just released on npm