From 645f38c2280224b163dafb1a2979f00999390ce9 Mon Sep 17 00:00:00 2001 From: Sheogorath Date: Fri, 30 Mar 2018 20:30:37 +0200 Subject: [PATCH 1/3] Update release notes Providing release notes for version 1.1.0-ce Signed-off-by: Sheogorath --- public/docs/release-notes.md | 83 +++++++++++++++++++++++++++++++----- 1 file changed, 73 insertions(+), 10 deletions(-) diff --git a/public/docs/release-notes.md b/public/docs/release-notes.md index 70510b1..4a3d576 100644 --- a/public/docs/release-notes.md +++ b/public/docs/release-notes.md @@ -1,6 +1,69 @@ Release Notes === + 1.1.0-ce 2018-03-28 15:00 +--- + +### Security +* Adding CSP headers +* Prevent data-leak by wrong LDAP config +* Generate dynamic sessionSecret if none is specifed + +### Enhancements +* Add Minio support +* Allow posting content to new notes by API +* Add anonymous edit function in restricted mode +* Add support for more Mimetypes on S3, minio and local filesystem uploads +* Add basic cli tooling for local user management +* Add referrer policy +* Add more usable HTML5 tags +* Add useridField in LDAP config +* Add option for ReportURI for CSP violations +* Add persistance for night mode +* Allow setting sessionSecret by environment variable +* Add night mode to features page + +### Fixes +* Fix todo toggle function +* Fix LDAP provider name usage +* Fix errors on authenticated sessions for deleted users +* Fix typo in database migration +* Fix possible data truncation of authorship +* Minor fixes in README.md +* Allow usage of esc-key by codemirror +* Fix array of emails in LDAP +* Fix type errors by environment configs +* Fix error message on some file API errors +* Fix minor CSS issues in night mode + +### Refactors +* Refactor contact +* Refactor social media integration on main page +* Refactor socket.io code to no longer use referrer +* Refactor webpack config to need less dependencies in package.json +* Refactor imageRouter for modularity +* Refactor configs to be camel case + +### Removes +* Remove unused `tokenSecret` from LDAP config + +### Deprecations +* All non-camelcase config + +### Honorable mentions +* [Dario Ernst (Nebukadneza)](https://github.com/Nebukadneza) +* [David Mehren (davidmehren)](https://github.com/davidmehren) +* [Dustin Frisch (fooker)](https://github.com/fooker) +* [Felix Schäfer (thegcat)](https://github.com/thegcat) +* [Literallie (xxyy)](https://github.com/xxyy) +* [Marc Deop (marcdeop)](https://github.com/marcdeop) +* [Max Wu (jackycute)](https://github.com/jackycute) +* [Robin Naundorf (senk)](https://github.com/senk) +* [Stefan Bühler (stbuehler)](https://github.com/stbuehler) +* [Takeaki Matsumoto (takmatsu)](https://github.com/takmatsu) +* [Tang TsungYi (vazontang)](https://github.com/vazontang) +* [Zearin (Zearin)](https://github.com/Zearin) + 1.0.1-ce 2018-01-19 15:00 --- @@ -46,7 +109,7 @@ Release Notes * Fix mermaid compatiblity with new version * Fix SSL CA path parsing -### Refactor +### Refactors * Refactor main page * Refactor status pages * Refactor config handling @@ -182,7 +245,7 @@ Release Notes * Fix client socket on delete event might not delete corresponding history record correctly * Fix to handle name or color is undefined error * Fix history item event not bind properly on pagination change -* Fix history time should save in UNIX timestamp to avoid time offset issue +* Fix history time should save in UNIX timestamp to avoid time offset issue ### Removes - Drop bower the package manager @@ -230,16 +293,16 @@ Release Notes ### Fixes * Fix README and features document format and grammar issues * Fix some potential memory leaks bugs -* Fix history storage might not fallback correctly +* Fix history storage might not fallback correctly * Fix to make mathjax expression display in editor correctly (not italic) -* Fix note title might have unstriped html tags +* Fix note title might have unstriped html tags * Fix client reconnect should resend last operation * Fix a bug when setting both maxAge and expires may cause user can't signin * Fix text complete extra tags for blockquote and referrals * Fix bug that when window close will make ajax fail and cause cookies set to wrong state * Fix markdown render might fall into regex infinite loop -* Fix syntax error caused by element contain special characters -* Fix reference error caused by some scripts loading order +* Fix syntax error caused by element contain special characters +* Fix reference error caused by some scripts loading order * Fix ToC id naming to avoid possible overlap with user ToC * Fix header nav bar rwd detect element should use div tag or it might glitch the layout * Fix textcomplete of extra tags for blockquote not match space character in the between @@ -279,7 +342,7 @@ Release Notes ### Fixes * Workaround vim mode might overwrite copy keyMap on Windows * Fix TOC might not update after changeMode -* Workaround slide mode gets glitch and blurry text on Firefox 47+ +* Workaround slide mode gets glitch and blurry text on Firefox 47+ * Fix idle.js not change isAway property on onAway and onAwayBack events * Fix http body request entity too large issue * Fix google-diff-match-patch encodeURI exception issue @@ -287,8 +350,8 @@ Release Notes * Fix spellcheck settings from cookies might not a boolean in string type * Fix cookies might not in boolean type cause page refresh loop * Fix the signin and logout redirect url might be empty -* Fix realtime might not clear or remove invalid sockets in queue -* Fix slide not refresh layout on ajax item loaded +* Fix realtime might not clear or remove invalid sockets in queue +* Fix slide not refresh layout on ajax item loaded * Fix retryOnDisconnect not clean up after reconnected * Fix some potential memory leaks @@ -342,7 +405,7 @@ Release Notes * Support maintenance mode and gracefully exit process on signal * Update to update doc in db when doc in filesystem have newer modified time * Update to replace animation acceleration library from gsap to velocity -* Support image syntax with size +* Support image syntax with size * Update textcomplete rules to support more conditions * Update to use bigger user profile image * Support showing signin button only when needed From 81e5ebf6d6caf78bd820e9d087b6301c78196dd3 Mon Sep 17 00:00:00 2001 From: Sheogorath Date: Thu, 5 Apr 2018 01:21:20 +0200 Subject: [PATCH 2/3] Add migration section to README.md As it was requested to be more visable, this commit adds a migration section about the introduced config style changes. Signed-off-by: Sheogorath --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0bb3845..ed0cc02 100644 --- a/README.md +++ b/README.md @@ -114,12 +114,19 @@ If you are upgrading HackMD from an older version, follow these steps: 6. Run `node_modules/.bin/sequelize db:migrate`, this step will migrate your db to the latest schema 7. Start your whole new server! -* [migration-to-0.5.0](https://github.com/hackmdio/migration-to-0.5.0) + +* **migrate-to-1.1.0** + +We deprecated the older lower case config style and moved on to camel case style. Please have a look at the current `config.json.example` and check the warnings on startup. + +*Notice: This is not a breaking change right now but in the future* + +* [**migration-to-0.5.0**](https://github.com/hackmdio/migration-to-0.5.0) We don't use LZString to compress socket.io data and DB data after version 0.5.0. Please run the migration tool if you're upgrading from the old version. -* [migration-to-0.4.0](https://github.com/hackmdio/migration-to-0.4.0) +* [**migration-to-0.4.0**](https://github.com/hackmdio/migration-to-0.4.0) We've dropped MongoDB after version 0.4.0. So here is the migration tool for you to transfer the old DB data to the new DB. From 23b5e9e54a8b27c789cc2a157f8e1b8be2d31197 Mon Sep 17 00:00:00 2001 From: Sheogorath Date: Fri, 6 Apr 2018 16:17:25 +0200 Subject: [PATCH 3/3] Minor fixes in relase notes Fix some spelling and style issues as well as adding the latest changes. Signed-off-by: Sheogorath --- public/docs/release-notes.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/public/docs/release-notes.md b/public/docs/release-notes.md index 4a3d576..a6428ee 100644 --- a/public/docs/release-notes.md +++ b/public/docs/release-notes.md @@ -1,36 +1,37 @@ Release Notes === - 1.1.0-ce 2018-03-28 15:00 + 1.1.0-ce 2018-04-06 12:00 --- ### Security * Adding CSP headers * Prevent data-leak by wrong LDAP config -* Generate dynamic sessionSecret if none is specifed +* Generate dynamic `sessionSecret` if none is specified ### Enhancements * Add Minio support * Allow posting content to new notes by API * Add anonymous edit function in restricted mode -* Add support for more Mimetypes on S3, minio and local filesystem uploads -* Add basic cli tooling for local user management +* Add support for more Mimetypes on S3, Minio and local filesystem uploads +* Add basic CLI tooling for local user management * Add referrer policy * Add more usable HTML5 tags -* Add useridField in LDAP config +* Add `useridField` in LDAP config * Add option for ReportURI for CSP violations * Add persistance for night mode -* Allow setting sessionSecret by environment variable +* Allow setting of `sessionSecret` by environment variable * Add night mode to features page +* Add Riot / Matrix - Community link to help page ### Fixes -* Fix todo toggle function -* Fix LDAP provider name usage +* Fix ToDo-toggle function +* Fix LDAP provider name in front-end * Fix errors on authenticated sessions for deleted users * Fix typo in database migration * Fix possible data truncation of authorship * Minor fixes in README.md -* Allow usage of esc-key by codemirror +* Allow usage of ESC-key by codemirror * Fix array of emails in LDAP * Fix type errors by environment configs * Fix error message on some file API errors