public-offering
/
pad.pub0.org
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: changelog update (#4776) 

Co-authored-by: Richard Hansen <rhansen@rhansen.org>
pull/4777/head^2
John McLear 2021-02-14 06:16:41 +00:00 committed by GitHub
parent e585d321f9
commit 13a0b0688f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
CHANGELOG.md
View File

@ -6,6 +6,12 @@
* The `bin/` and `tests/` directories were moved under `src/`. Symlinks were * The `bin/` and `tests/` directories were moved under `src/`. Symlinks were
added at the old locations to hopefully avoid breaking user scripts and other added at the old locations to hopefully avoid breaking user scripts and other
tools. tools.
* Dependencies are now installed with the `--no-optional` flag to speed
installation. Optional dependencies such as `sqlite3` must now be manually
installed (e.g., `(cd src && npm i sqlite3)`).
* Socket.IO messages are now limited to 1MiB to make denial of service attacks
more difficult. This may cause issues with plugins that send large messages,
e.g., `ep_image_upload`.
* The top-level `package.json` file, added in v1.8.7, has been removed due to * The top-level `package.json` file, added in v1.8.7, has been removed due to
problematic npm behavior. Whenever you install a plugin you will see the problematic npm behavior. Whenever you install a plugin you will see the
following benign warnings that can be safely ignored: following benign warnings that can be safely ignored:
@ -19,15 +25,19 @@
npm WARN develop No license field. npm WARN develop No license field.
``` ```
### Notable new features ### Notable enhancements
* You can now generate a link to a specific line number in a pad. Appending * You can now generate a link to a specific line number in a pad. Appending
`#L10` to a pad URL will cause your browser to scroll down to line 10. `#L10` to a pad URL will cause your browser to scroll down to line 10.
* Database performance is significantly improved. * Database performance is significantly improved.
* Admin UI now has test coverage in CI. (The tests are not enabled by default; * Browser caching improvements.
see `settings.json`.)
* New stats/metrics: `activePads`, `httpUptime`, `lastDisconnected`, * New stats/metrics: `activePads`, `httpUptime`, `lastDisconnected`,
`memoryUsageHeap`. `memoryUsageHeap`.
* Users can now pick absolute white (`#fff`) as their color.
* The `settings.json` template used for Docker images has new variables for
controlling rate limiting.
* Admin UI now has test coverage in CI. (The tests are not enabled by default
because the admin password is required; see `settings.json`.)
* For plugin authors: * For plugin authors:
* New `callAllSerial()` function that invokes hook functions like `callAll()` * New `callAllSerial()` function that invokes hook functions like `callAll()`
except it supports asynchronous hook functions. except it supports asynchronous hook functions.
@ -39,17 +49,20 @@
* Backend tests for plugins can now use the * Backend tests for plugins can now use the
[`ep_etherpad-lite/tests/backend/common`](src/tests/backend/common.js) [`ep_etherpad-lite/tests/backend/common`](src/tests/backend/common.js)
module to start the server and simplify API access. module to start the server and simplify API access.
* The `checkPlugins.js` script now automatically adds GitHub CI test coverage
badges for backend tests and npm publish.
### Notable fixes ### Notable fixes
* Enter key now stays in focus when inserted at bottom of viewport. * Enter key now stays in focus when inserted at bottom of viewport.
* Numbering for ordered list items now properly increments when exported to
text.
* Suppressed benign socket.io connection errors * Suppressed benign socket.io connection errors
* Interface no longer loses color variants on disconnect/reconnect event. * Interface no longer loses color variants on disconnect/reconnect event.
* Removed npm.load to support npm7.
* General code quality is further significantly improved. * General code quality is further significantly improved.
* Restarting Etherpad via `/admin` actions is more robust.
* Improved reliability of server shutdown and restart. * Improved reliability of server shutdown and restart.
* No longer error if no buttons are visible. * No longer error if no buttons are visible.
* Update Socket.IO to address a minor security vulnerability.
* For plugin authors: * For plugin authors:
* Fixed `collectContentLineText` return value handling. * Fixed `collectContentLineText` return value handling.