NXDRIVE-1552: Release 4.1.0

nuxeo · Mar 26, 2019 · 2ea134f · 2ea134f
1 parent c36d841
commit 2ea134f
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 16 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -5,7 +5,7 @@
 - [configuration.md](configuration.md): How to permanently configure Drive and the list of command line arguments.
 - [contextual_menu.md](contextual_menu.md): How to install contextual menu items.
 - [deployment.md](deployment.md): How to setup a complete development environment for Drive.
-- [icon_overlay.md](icon_overlay.md): **TO COMPLETE** How to install icon overlay.
+- [icon_overlay.md](icon_overlay.md): How to install icon overlay.
 - [installer.md](installer.md): How we package Nuxeo Drive and installers OS-specific information.
 - [manual_init.md](manual_init.md): How to manually initialize a Nuxeo Drive instance.
 - [support.md](support.md): List of supported OS versions, Python version, limitations and translations. Useful for the **support**.

diff --git a/docs/changes.md b/docs/changes.md
@@ -4,6 +4,10 @@
 
 - [4.0.0](changes/4.0.0.md)
 - [4.0.1](changes/4.0.1.md)
+- [4.0.2](changes/4.0.2.md)
+- [4.0.3](changes/4.0.3.md)
+- [4.0.4](changes/4.0.4.md)
+- [4.1.0](changes/4.1.0.md)
 
 ## 3.x
 

diff --git a/docs/changes/4.1.0.md b/docs/changes/4.1.0.md
@@ -1,6 +1,6 @@
 # 4.1.0
 
-Release date: `2019-xx-xx`
+Release date: `2019-03-26`
 
 ## Core
 
@@ -21,14 +21,14 @@ Release date: `2019-xx-xx`
 - [NXDRIVE-1511](https://jira.nuxeo.com/browse/NXDRIVE-1511): Fix pair state for 'unsynchronized' and 'synchronized'
 - [NXDRIVE-1517](https://jira.nuxeo.com/browse/NXDRIVE-1517): Ensure remote ref is always set
 - [NXDRIVE-1518](https://jira.nuxeo.com/browse/NXDRIVE-1518): Fix watchdog observer `stop()` call
-- [NXDRIVE-1519](https://jira.nuxeo.com/browse/NXDRIVE-1519): Allow DirectEditing documents with the Folderish facet
+- [NXDRIVE-1519](https://jira.nuxeo.com/browse/NXDRIVE-1519): Allow DirectEdit'ing documents with the Folderish facet
 - [NXDRIVE-1520](https://jira.nuxeo.com/browse/NXDRIVE-1520): Always send statistics, even if there is no engine
-- [NXDRIVE-1523](https://jira.nuxeo.com/browse/NXDRIVE-1523): Handle paths with more than 143 chars on encrypted FS
+- [NXDRIVE-1523](https://jira.nuxeo.com/browse/NXDRIVE-1523): (GNU/Linux) Handle paths with more than 143 chars on encrypted FS
 - [NXDRIVE-1529](https://jira.nuxeo.com/browse/NXDRIVE-1529): Review behavior of Windows registry functions
 - [NXDRIVE-1530](https://jira.nuxeo.com/browse/NXDRIVE-1530): Handle `PermissionError` when trashing documents
 - [NXDRIVE-1531](https://jira.nuxeo.com/browse/NXDRIVE-1531): Fix QThread exception on exit
 - [NXDRIVE-1534](https://jira.nuxeo.com/browse/NXDRIVE-1534): Do not consider HTTP timeouts as errors in the Remote Watcher
-- [NXDRIVE-1535](https://jira.nuxeo.com/browse/NXDRIVE-1535): Handle `Unauthorized` errors from Processor
+- [NXDRIVE-1535](https://jira.nuxeo.com/browse/NXDRIVE-1535): Handle `Unauthorized` errors from the Processor
 - [NXDRIVE-1537](https://jira.nuxeo.com/browse/NXDRIVE-1537): Prompt the user for metrics sharing settings
 - [NXDRIVE-1540](https://jira.nuxeo.com/browse/NXDRIVE-1540): Avoid renaming banned files
 - [NXDRIVE-1543](https://jira.nuxeo.com/browse/NXDRIVE-1543): Make `LocalClient.exists()` return False on any `OSError`
@@ -41,7 +41,7 @@ Release date: `2019-xx-xx`
 - [NXDRIVE-1559](https://jira.nuxeo.com/browse/NXDRIVE-1559): Use separate prompts for downgrade in cases of incompatibility or wrong channel
 - [NXDRIVE-1561](https://jira.nuxeo.com/browse/NXDRIVE-1561): Display the fatal error screen only when necessary
 - [NXDRIVE-1562](https://jira.nuxeo.com/browse/NXDRIVE-1562): Handle `MemoryError` in `get_open_files()`
-- [NXDRIVE-1563](https://jira.nuxeo.com/browse/NXDRIVE-1563): Prevent user from running the app from a modified path and inform them
+- [NXDRIVE-1563](https://jira.nuxeo.com/browse/NXDRIVE-1563): (macOS) Prevent user from running the app from a modified path and inform them
 - [NXDRIVE-1567](https://jira.nuxeo.com/browse/NXDRIVE-1567): Use UTF-8 as encoding when dumping a database
 - [NXDRIVE-1568](https://jira.nuxeo.com/browse/NXDRIVE-1568): Fix authentication expired notification
 - [NXDRIVE-1569](https://jira.nuxeo.com/browse/NXDRIVE-1569): Ignore Adobe InDesign lock files
@@ -75,10 +75,11 @@ Release date: `2019-xx-xx`
 - [NXDRIVE-1510](https://jira.nuxeo.com/browse/NXDRIVE-1510): Unskip `test_move_untrash_file_on_parent_with_no_rights()` since [NXP-25066](https://jira.nuxeo.com/browse/NXP-25066) has been resolved sometime ago
 - [NXDRIVE-1536](https://jira.nuxeo.com/browse/NXDRIVE-1536): Use mock'ed objects instead of manual swap
 - [NXDRIVE-1542](https://jira.nuxeo.com/browse/NXDRIVE-1542): Unlock tests parallelization!
-- [NXDRIVE-1546](https://jira.nuxeo.com/browse/NXDRIVE-1546): Filter out `KeyboardInterrupt` errors
+- [NXDRIVE-1546](https://jira.nuxeo.com/browse/NXDRIVE-1546): Filter out `KeyboardInterrupt` errors from Sentry events
 
 ## Minor Changes
 
+- Logging: The `TRACE` level has been removed
 - Packaging: Added `faker` 1.0.4
 - Packaging: Added `pyobjc-framework-ScriptingBridge` 4.2.2
 - Packaging: Added `PyQt5-sip` 4.19.13
@@ -92,22 +93,21 @@ Release date: `2019-xx-xx`
 - Packaging: Updated `pycryptodomex` from 3.7.2 to 3.7.3
 - Packaging: Updated `pytest` from 3.8.2 to 4.3.1
 - Packaging: Updated `python-dateutil` from 2.7.5 to 2.8.0
-- Testing: The SENTRY_ENV envar is now mandatory
-- Logging: The TRACE level has been removed
+- Testing: The `SENTRY_ENV` envar is now mandatory
 
 ## Techical Changes
 
 - Changed type of all local paths from `str` to pathlib `Path`
 - Added `AbstractOSIntegration.addons_installed()`
 - Added `AbstractOSIntegration.get_extension_listener()`
 - Added `AbstractOSIntegration.install_addons()`
+- Removed `name` keyword argument from `AbstractOSIntegration.register_folder_link()`
 - Added `Application.confirm_deletion()`
 - Added `BaseUpdater.get_version_channel()`
 - Added `ConfigurationDAO.get_bool()`
 - Added `ConfigurationDAO.get_int()`
 - Added `ConfigurationDAO.store_bool()`
 - Added `ConfigurationDAO.store_int()`
-- Removed `name` keyword argument from `AbstractOSIntegration.register_folder_link()`
 - Added `DarwinIntegration.get_extension_listener()`
 - Added `DarwinIntegration.open_local_file()`
 - Added `Engine.delete_doc()`
@@ -129,11 +129,12 @@ Release date: `2019-xx-xx`
 - Added `NuxeoDocumentInfo.get_blob()`
 - Added `QMLDriveApi.get_deletion_behavior()`
 - Added `QMLDriveApi.get_log_level()`
+- Added `QMLDriveApi.restart_needed()`
 - Added `QMLDriveApi.set_deletion_behavior()`
 - Added `QMLDriveApi.set_log_level()`
-- Added `QMLDriveApi.restart_needed()`
 - Removed `QMLDriveApi.get_tracking()`
 - Removed `QMLDriveApi.set_tracking()`
+- Added `Remote.execute()`
 - Added `WindowsIntegration.addons_installed()`
 - Added `WindowsIntegration.get_extension_listener()`
 - Added `WindowsIntegration.install_addons()`
@@ -143,7 +144,6 @@ Release date: `2019-xx-xx`
 - Added `WindowsIntegration.watch_folder()`
 - Removed `Worker.get_thread()`. Use `thread` attribute instead.
 - Removed `Worker.get_thread_id()`. Use `thread_id` attribute instead.
-- Added `Remote.execute()`
 - Added constants.py::`COMPANY`
 - Added constants.py::`DelAction`
 - Added engine/dao/sqlite.py::`prepare_args()`
@@ -158,13 +158,13 @@ Release date: `2019-xx-xx`
 - Added options.py::`use_analytics`
 - Added options.py::`use_sentry`
 - Changed options_updater.py to poll_workers.py
+- Added osi/darwin/extension.py
 - Added osi/darwin/files.py
 - Removed osi/darwin/darwin.py::`FinderSyncServer`
-- Added osi/darwin/extension.py
 - Added osi/extension.py
 - Added osi/linux
-- Added osi/windows/files.py
 - Added osi/windows/extension.py
+- Added osi/windows/files.py
 - Added poll_workers.py::`DatabaseBackupWorker`
 - Added updater/constants.py::`Login`
 - Added updater/utils.py::`get_compatible_versions()`

diff --git a/docs/configuration.md b/docs/configuration.md
@@ -67,6 +67,7 @@ Parameter values are taken as is, except for booleans. In that case, you can spe
 | `beta-update-site-url` | [URL](https://community.nuxeo.com/static/drive-updates) (str) | 4.0.2 | None | None
 | `beta-channel` | False (bool) | 4.0.2 | `channel` | release (str)
 | `consider-ssl-errors` | True (bool) | 4.0.1 | `ssl-no-verify` | False (bool)
+| `debug` | False (bool) | 4.0.0 | None | None
 | `proxy-exceptions` | None (str) | 4.0.0 | None | None
 | `proxy-type` | None (str) | 4.0.0 | None | None
 

diff --git a/docs/icon_overlay.md b/docs/icon_overlay.md
@@ -30,6 +30,7 @@ The revelant source code can be found in the `tools/windows/setup-admin.iss` fil
 ### Building
 
 The setup to build the DLLs on Windows 7 is the following:
+
 - Visual Studio Express 2010
 - The [Windows SDK for Windows 7 and .NET Framework 4](https://www.microsoft.com/en-us/download/details.aspx?id=8279)
 - The [Windows Driver Kit 7.1.0](https://www.microsoft.com/en-us/download/details.aspx?id=11800)
@@ -47,19 +48,23 @@ Once DLLs are compiled, we move them to the `nuxeo-drive/tools/windows/dll/(x86|
 During installation, Inno Setup will take care of running `regsvr32` on them so that they are registered with the system and executed by the Explorer.
 
 Drive itself is responsible for:
+
 - Writing the watched folder(s) in a `FilterFolders` value of the `HKCU\\Software\\Nuxeo\\Drive\\Overlays` register key. It should be formatted like a JSON array of strings.
 - Writing `1` in an `EnableOverlay` value of the same key.
 - Listening on port 10650 with a TCP socket.
 
 The DLL will asks for status by sending a command in JSON, e.g.
-```
+
+```json
 {
     "command": "getFileIconId",
     "value": "C:\\Users\\Windows7\\Documents\\Nuxeo Drive"
 }
 ```
+
 and waits for a response with the status id of the target file, e.g.
-```
+
+```json
 {
     "value": "1"
 }