From 2a62bbdbd30440acb5b965e952a216fb44d7e562 Mon Sep 17 00:00:00 2001 From: Henry Heino <46334387+personalizedrefrigerator@users.noreply.github.com> Date: Tue, 21 Nov 2023 07:10:37 -0800 Subject: [PATCH 01/13] Chore: Fixes #9353: CI: Run tests on pull requests from other branches of the main repository (#9354) --- .github/scripts/run_ci.sh | 42 +++++++++++++++++++++++++++------------ 1 file changed, 29 insertions(+), 13 deletions(-) diff --git a/.github/scripts/run_ci.sh b/.github/scripts/run_ci.sh index a185a94d8ad..0e8fef49874 100755 --- a/.github/scripts/run_ci.sh +++ b/.github/scripts/run_ci.sh @@ -8,16 +8,23 @@ SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )" ROOT_DIR="$SCRIPT_DIR/../.." IS_PULL_REQUEST=0 -IS_DEV_BRANCH=0 +IS_DESKTOP_RELEASE=0 +IS_SERVER_RELEASE=0 IS_LINUX=0 IS_MACOS=0 +# If pull requests are coming from a branch of the main repository, +# IS_PULL_REQUEST will be zero. if [ "$GITHUB_EVENT_NAME" == "pull_request" ]; then IS_PULL_REQUEST=1 fi -if [ "$GITHUB_REF" == "refs/heads/dev" ]; then - IS_DEV_BRANCH=1 +if [[ $GIT_TAG_NAME = $SERVER_TAG_PREFIX-* ]]; then + IS_SERVER_RELEASE=1 +fi + +if [[ $GIT_TAG_NAME = v* ]]; then + IS_DESKTOP_RELEASE=1 fi if [ "$RUNNER_OS" == "Linux" ]; then @@ -28,6 +35,14 @@ else IS_MACOS=1 fi +# Tests can randomly fail in some cases, so only run them when not publishing +# a release +RUN_TESTS=0 + +if [ "$IS_SERVER_RELEASE" = 0 ] && [ "$IS_DESKTOP_RELEASE" = 0 ]; then + RUN_TESTS=1 +fi + # ============================================================================= # Print environment # ============================================================================= @@ -43,7 +58,9 @@ echo "SERVER_TAG_PREFIX=$SERVER_TAG_PREFIX" echo "IS_CONTINUOUS_INTEGRATION=$IS_CONTINUOUS_INTEGRATION" echo "IS_PULL_REQUEST=$IS_PULL_REQUEST" -echo "IS_DEV_BRANCH=$IS_DEV_BRANCH" +echo "IS_DESKTOP_RELEASE=$IS_DESKTOP_RELEASE" +echo "IS_SERVER_RELEASE=$IS_SERVER_RELEASE" +echo "RUN_TESTS=$RUN_TESTS" echo "IS_LINUX=$IS_LINUX" echo "IS_MACOS=$IS_MACOS" @@ -64,11 +81,10 @@ if [ $testResult -ne 0 ]; then fi # ============================================================================= -# Run test units. Only do it for pull requests and dev branch because we don't -# want it to randomly fail when trying to create a desktop release. +# Run test units # ============================================================================= -if [ "$IS_PULL_REQUEST" == "1" ] || [ "$IS_DEV_BRANCH" = "1" ]; then +if [ "$RUN_TESTS" == "1" ]; then echo "Step: Running tests..." # On Linux, we run the Joplin Server tests using PostgreSQL @@ -102,7 +118,7 @@ fi # Check that the website builder can run without errors # ============================================================================= -if [ "$IS_PULL_REQUEST" == "1" ] || [ "$IS_DEV_BRANCH" = "1" ]; then +if [ "$RUN_TESTS" == "1" ]; then if [ "$IS_LINUX" == "1" ]; then echo "Step: Running website builder..." node packages/tools/website/processDocs.js --env dev @@ -114,7 +130,7 @@ fi # release randomly fail. # ============================================================================= -if [ "$IS_PULL_REQUEST" == "1" ] || [ "$IS_DEV_BRANCH" = "1" ]; then +if [ "$RUN_TESTS" == "1" ]; then echo "Step: Running linter..." yarn run linter-ci ./ @@ -154,7 +170,7 @@ fi # what commit may have broken translation building. # ============================================================================= -if [ "$IS_PULL_REQUEST" == "1" ] || [ "$IS_DEV_BRANCH" = "1" ]; then +if [ "$RUN_TESTS" == "1" ]; then if [ "$IS_LINUX" == "1" ]; then echo "Step: Checking for lost translation strings..." @@ -190,7 +206,7 @@ fi # Check that the website still builds # ============================================================================= -if [ "$IS_PULL_REQUEST" == "1" ] || [ "$IS_DEV_BRANCH" = "1" ]; then +if [ "$RUN_TESTS" == "1" ]; then echo "Step: Check that the website still builds..." mkdir -p ../joplin-website/docs @@ -226,7 +242,7 @@ fi cd "$ROOT_DIR/packages/app-desktop" -if [[ $GIT_TAG_NAME = v* ]]; then +if [ "$IS_DESKTOP_RELEASE" == "1" ]; then echo "Step: Building and publishing desktop application..." # cd "$ROOT_DIR/packages/tools" # node bundleDefaultPlugins.js @@ -251,7 +267,7 @@ if [[ $GIT_TAG_NAME = v* ]]; then else USE_HARD_LINKS=false yarn run dist fi -elif [[ $IS_LINUX = 1 ]] && [[ $GIT_TAG_NAME = $SERVER_TAG_PREFIX-* ]]; then +elif [[ $IS_LINUX = 1 ]] && [ "$IS_SERVER_RELEASE" == "1" ]; then echo "Step: Building Docker Image..." cd "$ROOT_DIR" yarn run buildServerDocker --tag-name $GIT_TAG_NAME --push-images --repository $SERVER_REPOSITORY From 99be29707fc146b0eb4db2f990d50a6894811747 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 21 Nov 2023 18:29:01 +0000 Subject: [PATCH 02/13] Update dependency @react-native-community/netinfo to v9.4.2 (#9357) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- packages/app-mobile/package.json | 2 +- yarn.lock | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/packages/app-mobile/package.json b/packages/app-mobile/package.json index dcffafc29ce..2bf4f875fda 100644 --- a/packages/app-mobile/package.json +++ b/packages/app-mobile/package.json @@ -28,7 +28,7 @@ "@react-native-community/clipboard": "1.5.1", "@react-native-community/datetimepicker": "7.6.1", "@react-native-community/geolocation": "3.1.0", - "@react-native-community/netinfo": "9.4.1", + "@react-native-community/netinfo": "9.4.2", "@react-native-community/push-notification-ios": "1.11.0", "@react-native-community/slider": "4.4.3", "assert-browserify": "2.0.0", diff --git a/yarn.lock b/yarn.lock index a2528fbed72..cd540c427dd 100644 --- a/yarn.lock +++ b/yarn.lock @@ -6305,7 +6305,7 @@ __metadata: "@react-native-community/clipboard": 1.5.1 "@react-native-community/datetimepicker": 7.6.1 "@react-native-community/geolocation": 3.1.0 - "@react-native-community/netinfo": 9.4.1 + "@react-native-community/netinfo": 9.4.2 "@react-native-community/push-notification-ios": 1.11.0 "@react-native-community/slider": 4.4.3 "@testing-library/jest-native": 5.4.3 @@ -8976,12 +8976,12 @@ __metadata: languageName: node linkType: hard -"@react-native-community/netinfo@npm:9.4.1": - version: 9.4.1 - resolution: "@react-native-community/netinfo@npm:9.4.1" +"@react-native-community/netinfo@npm:9.4.2": + version: 9.4.2 + resolution: "@react-native-community/netinfo@npm:9.4.2" peerDependencies: react-native: ">=0.59" - checksum: cf6471a50a5282f858797cda7531c61ac3d94de2e1c379b14a11f6b049f582606dae55a041dd900c56b01faf69eb5cfef9b4e84b0ea7f02de52804aa5a6e22df + checksum: b7783d615dec52e89dfd5f435101c06a1b17b11d6702685ad0ad73fb5c9d3ab6997e7a640b7f0f1f5bb068135331adfb5fb77280ec7b3a19e4332f50f055efd8 languageName: node linkType: hard From 9b89f4ecfb7584e170d257a577f61d0bd6228522 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 22 Nov 2023 01:34:11 +0000 Subject: [PATCH 03/13] Update dependency @types/react to v18.2.34 (#9358) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- packages/app-desktop/package.json | 2 +- packages/app-mobile/package.json | 2 +- packages/editor/package.json | 2 +- packages/lib/package.json | 2 +- packages/pdf-viewer/package.json | 2 +- yarn.lock | 18 +++++++++--------- 6 files changed, 14 insertions(+), 14 deletions(-) diff --git a/packages/app-desktop/package.json b/packages/app-desktop/package.json index 815c15efc75..6865fdd4226 100644 --- a/packages/app-desktop/package.json +++ b/packages/app-desktop/package.json @@ -121,7 +121,7 @@ "@testing-library/react-hooks": "8.0.1", "@types/jest": "29.5.5", "@types/node": "18.18.8", - "@types/react": "18.2.33", + "@types/react": "18.2.34", "@types/react-redux": "7.1.28", "@types/styled-components": "5.1.29", "electron": "26.5.0", diff --git a/packages/app-mobile/package.json b/packages/app-mobile/package.json index 2bf4f875fda..b1ed5a91940 100644 --- a/packages/app-mobile/package.json +++ b/packages/app-mobile/package.json @@ -95,7 +95,7 @@ "@tsconfig/react-native": "2.0.2", "@types/fs-extra": "11.0.3", "@types/jest": "29.5.5", - "@types/react": "18.2.33", + "@types/react": "18.2.34", "@types/react-native": "0.70.6", "@types/react-redux": "7.1.28", "@types/tar-stream": "2.2.3", diff --git a/packages/editor/package.json b/packages/editor/package.json index 47ca0fed8ae..477667d1131 100644 --- a/packages/editor/package.json +++ b/packages/editor/package.json @@ -17,7 +17,7 @@ "@joplin/lib": "~2.13", "@testing-library/react-hooks": "8.0.1", "@types/jest": "29.5.5", - "@types/react": "18.2.33", + "@types/react": "18.2.34", "@types/react-redux": "7.1.28", "@types/styled-components": "5.1.29", "jest": "29.7.0", diff --git a/packages/lib/package.json b/packages/lib/package.json index 381f49f4d39..0ea203e7f2d 100644 --- a/packages/lib/package.json +++ b/packages/lib/package.json @@ -21,7 +21,7 @@ "@types/js-yaml": "4.0.8", "@types/node": "18.18.8", "@types/node-rsa": "1.1.3", - "@types/react": "18.2.33", + "@types/react": "18.2.34", "@types/uuid": "9.0.6", "clean-html": "1.5.0", "jest": "29.7.0", diff --git a/packages/pdf-viewer/package.json b/packages/pdf-viewer/package.json index 1028fcfa3f3..be9abb2b54e 100644 --- a/packages/pdf-viewer/package.json +++ b/packages/pdf-viewer/package.json @@ -21,7 +21,7 @@ "devDependencies": { "@types/jest": "29.5.5", "@types/pdfjs-dist": "2.10.378", - "@types/react": "18.2.33", + "@types/react": "18.2.34", "@types/react-dom": "18.2.14", "@types/styled-components": "5.1.29", "babel-jest": "29.7.0", diff --git a/yarn.lock b/yarn.lock index cd540c427dd..0231faa5cdc 100644 --- a/yarn.lock +++ b/yarn.lock @@ -6225,7 +6225,7 @@ __metadata: "@types/jest": 29.5.5 "@types/mustache": 4.2.4 "@types/node": 18.18.8 - "@types/react": 18.2.33 + "@types/react": 18.2.34 "@types/react-redux": 7.1.28 "@types/styled-components": 5.1.29 async-mutex: 0.4.0 @@ -6313,7 +6313,7 @@ __metadata: "@tsconfig/react-native": 2.0.2 "@types/fs-extra": 11.0.3 "@types/jest": 29.5.5 - "@types/react": 18.2.33 + "@types/react": 18.2.34 "@types/react-native": 0.70.6 "@types/react-redux": 7.1.28 "@types/tar-stream": 2.2.3 @@ -6434,7 +6434,7 @@ __metadata: "@replit/codemirror-vim": 6.0.14 "@testing-library/react-hooks": 8.0.1 "@types/jest": 29.5.5 - "@types/react": 18.2.33 + "@types/react": 18.2.34 "@types/react-redux": 7.1.28 "@types/styled-components": 5.1.29 jest: 29.7.0 @@ -6517,7 +6517,7 @@ __metadata: "@types/nanoid": 3.0.0 "@types/node": 18.18.8 "@types/node-rsa": 1.1.3 - "@types/react": 18.2.33 + "@types/react": 18.2.34 "@types/uuid": 9.0.6 async-mutex: 0.4.0 base-64: 1.0.0 @@ -6589,7 +6589,7 @@ __metadata: "@joplin/lib": ~2.13 "@types/jest": 29.5.5 "@types/pdfjs-dist": 2.10.378 - "@types/react": 18.2.33 + "@types/react": 18.2.34 "@types/react-dom": 18.2.14 "@types/styled-components": 5.1.29 async-mutex: 0.4.0 @@ -10659,14 +10659,14 @@ __metadata: languageName: node linkType: hard -"@types/react@npm:18.2.33": - version: 18.2.33 - resolution: "@types/react@npm:18.2.33" +"@types/react@npm:18.2.34": + version: 18.2.34 + resolution: "@types/react@npm:18.2.34" dependencies: "@types/prop-types": "*" "@types/scheduler": "*" csstype: ^3.0.2 - checksum: 75903c4d53898c69dd23d0b2730eac4676dc5ade15c25c793dec855f0d7c650cb823832bb1dd881efe8895724f15b06d4bf7081ea0b82391aa3059512ad49ccf + checksum: 16446542228cba827143caf0ecb4718cbf02ae5befd4a6bc6d67ed144fe1c0cb4b06b20facf3d2b972d86c67a17cc82f5ec8a03fce42d50e12b2dcd0592fc66e languageName: node linkType: hard From c78afc46c9095b9f84e2640f9e1a26c1ef113394 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 22 Nov 2023 14:06:07 +0000 Subject: [PATCH 04/13] Update dependency style-to-js to v1.1.9 (#9359) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- packages/tools/package.json | 2 +- yarn.lock | 20 ++++++++++---------- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/packages/tools/package.json b/packages/tools/package.json index 3cdc6df1761..9ff91c8dea6 100644 --- a/packages/tools/package.json +++ b/packages/tools/package.json @@ -61,7 +61,7 @@ "rss": "1.2.2", "sass": "1.69.5", "sqlite3": "5.1.6", - "style-to-js": "1.1.8", + "style-to-js": "1.1.9", "typescript": "5.2.2" }, "gitHead": "05a29b450962bf05a8642bbd39446a1f679a96ba" diff --git a/yarn.lock b/yarn.lock index 0231faa5cdc..919d84d1cd6 100644 --- a/yarn.lock +++ b/yarn.lock @@ -6809,7 +6809,7 @@ __metadata: sharp: 0.32.6 source-map-support: 0.5.21 sqlite3: 5.1.6 - style-to-js: 1.1.8 + style-to-js: 1.1.9 typescript: 5.2.2 uri-template: 2.0.0 yargs: 17.7.2 @@ -39048,12 +39048,12 @@ __metadata: languageName: node linkType: hard -"style-to-js@npm:1.1.8": - version: 1.1.8 - resolution: "style-to-js@npm:1.1.8" +"style-to-js@npm:1.1.9": + version: 1.1.9 + resolution: "style-to-js@npm:1.1.9" dependencies: - style-to-object: 1.0.3 - checksum: cc4d4284af587bf74559a6da17dadb88c96c8054755666cce1b768615ac2bd6231ce332a8cee118acafb577f51f243b795b716326b3c617ec12151d23f660d8f + style-to-object: 1.0.4 + checksum: f05dcd9edc7c2b530159c3eea7be558ebd324073dad444220ca3c12a15bdfa55f5690625238597190d0e21cc87433d6b745eb757055e0e781998153863fdc105 languageName: node linkType: hard @@ -39066,12 +39066,12 @@ __metadata: languageName: node linkType: hard -"style-to-object@npm:1.0.3": - version: 1.0.3 - resolution: "style-to-object@npm:1.0.3" +"style-to-object@npm:1.0.4": + version: 1.0.4 + resolution: "style-to-object@npm:1.0.4" dependencies: inline-style-parser: 0.2.2 - checksum: fca6b35dc704656163c4b11d514ada9f9998fb434c9cec5995445d7d7d595ba3a4fda0476016d625cbb282d43ba5123ef0b5871d855d391400bb0dc2c2beeae1 + checksum: d3d2ea838b7777d3d6db165df8322e0f6b4f550f081e5833c89c4d91e5de2f7a09fa81cfd2208221683a94e476d4fc24df65c4d3ab75ddd45b419bef9426fbaf languageName: node linkType: hard From 52a3a59623846605293969f8ed96b290ccc670f2 Mon Sep 17 00:00:00 2001 From: Joplin Bot Date: Wed, 22 Nov 2023 18:14:21 +0000 Subject: [PATCH 05/13] Doc: Auto-update documentation Auto-updated using release-website.sh --- readme/about/changelog/desktop.md | 164 +++++++++--------------------- 1 file changed, 49 insertions(+), 115 deletions(-) diff --git a/readme/about/changelog/desktop.md b/readme/about/changelog/desktop.md index 760eb3ea813..1f896d6391a 100644 --- a/readme/about/changelog/desktop.md +++ b/readme/about/changelog/desktop.md @@ -3845,121 +3845,6 @@ Note: This fixes an invalid database upgrade in the previous version. - Improved: Fixes [#268](https://github.com/laurent22/joplin/issues/268): Improve error message for invalid flags - Fix: Fixes [#271](https://github.com/laurent22/joplin/issues/271): Sort by created time was not respected -## [v1.0.70](https://github.com/laurent22/joplin/releases/tag/v1.0.70) - 2018-02-28T20:04:30Z - -- New: Resolves [#97](https://github.com/laurent22/joplin/issues/97): Export to JEX format or RAW format -- New: Import JEX and RAW format -- New: Resolves [#52](https://github.com/laurent22/joplin/issues/52): Import Markdown files or directory -- New: Allow sorting notes by various fields -- New: Resolves [#243](https://github.com/laurent22/joplin/issues/243): Added black and white tray icon for macOS -- Fix: [#247](https://github.com/laurent22/joplin/issues/247): Unreadable error messages when checking for updates -- Fix: Fixed sync interval sorting order -- Fix: [#256](https://github.com/laurent22/joplin/issues/256): Check that no other instance of Joplin is running before launching a new one - -## [v1.0.67](https://github.com/laurent22/joplin/releases/tag/v1.0.67) - 2018-02-19T22:51:08Z - -- Fixed: [#217](https://github.com/laurent22/joplin/issues/217): Display a message when the note has no content and only the note viewer is visible -- Fixed: [#240](https://github.com/laurent22/joplin/issues/240): Tags should be handled in a case-insensitive way -- Fixed: [#241](https://github.com/laurent22/joplin/issues/241): Ignore response for certain WebDAV calls to improve compatibility with some services. -- Updated: French and Español translation - -## [v1.0.66](https://github.com/laurent22/joplin/releases/tag/v1.0.66) - 2018-02-18T23:09:09Z - -- Fixed: Local items were no longer being deleted via sync. -- Improved: More debug information when WebDAV sync target does not work. -- Improved: Compatibility with some WebDAV services (Seafile in particular) - -## [v1.0.65](https://github.com/laurent22/joplin/releases/tag/v1.0.65) - 2018-02-17T20:02:25Z - -- New: Added several keyboard shortcuts -- New: Convert new lines in tables to BR tags, and added support for HTML tags in Markdown viewers -- Fixed: Confirmation message boxes, and release notes text -- Fixed: Issue with items not being decrypted immediately when they are created due to a sync conflict. -- Updated: Translations - -## [v1.0.64](https://github.com/laurent22/joplin/releases/tag/v1.0.64) - 2018-02-16T00:58:20Z - -Still more fixes and improvements to get v1 as stable as possible before adding new features. - -IMPORTANT: If you use Nextcloud it is recommended to sync all your notes before installing this release (see below). - -- Fixed: Nextcloud sync target ID (which was incorrectly set to WebDAV sync ID). As a result items that have been created since this bug will be re-synced with Nextcloud. This sync will not duplicate or delete any item but is necessary to preserve data integrity. IF YOU HAVE NOTES IN CONFLICT AFTER SYNC: Close the app completely and restart it to make sure all the lists are visually up-to-date. The notes in conflict most likely can be ignored - they are just duplicate of the real ones. To be safe, check the content but most likely they can simply be deleted. -- Improved: Provide Content-Length header for WebDAV for better compatibility with more servers -- Fixed: Allow copy and paste from config and encryption screen on macOS -- Fixed: [#201](https://github.com/laurent22/joplin/issues/201), [#216](https://github.com/laurent22/joplin/issues/216): Make sure only one update check can run at a time, and improved modal dialog boxes - -## [v1.0.63](https://github.com/laurent22/joplin/releases/tag/v1.0.63) - 2018-02-14T19:40:36Z - -- Improved the way settings are changed. Should also fixed issue with sync context being accidentally broken. -- Improved WebDAV driver compatibility with some services (eg. Seafile) - -## [v1.0.62](https://github.com/laurent22/joplin/releases/tag/v1.0.62) - 2018-02-12T20:19:58Z - -- Fixes [#205](https://github.com/laurent22/joplin/issues/205): Importing Evernote notes while on import page re-imports previous import -- Fixes [#209](https://github.com/laurent22/joplin/issues/209): Items with non-ASCII characters end up truncated on Nextcloud -- Added Basque translation, fixed issue with handling invalid translations. Updated translation FR. - -## [v0.10.61](https://github.com/laurent22/joplin/releases/tag/v0.10.61) - 2018-02-08T18:27:39Z - -- New: Display message when creating new note or to-do so that it doesn't look like the previous note content got deleted. -- New: Also support $ as delimiter for Katex expressions -- New: Added sync config check to config screens -- New: Allowing opening and saving resource images -- New: Toolbar button to set tags -- Update: Improved request repeating mechanism -- Fix: Make sure alarms and resources are attached to right note when creating new note -- Fix: Use mutex when saving model to avoid race conditions when decrypting and syncing at the same time - -## [v0.10.60](https://github.com/laurent22/joplin/releases/tag/v0.10.60) - 2018-02-06T13:09:56Z - -- New: WebDAV synchronisation target -- New: Support for math typesetting [Katex](https://khan.github.io/KaTeX/) -- New: Tray icon for Windows and macOS -- Fixed: Don't allow adding notes to conflict notebook -- Updated: Russian translation -- Updated: French translation -- New: List missing master keys in encryption screen -- Fixed: Attaching images in Linux was no longer working -- Fixed crash in macOS - -## [v0.10.54](https://github.com/laurent22/joplin/releases/tag/v0.10.54) - 2018-01-31T20:21:30Z - -- Optimised Nextcloud functionality so that it is faster and consumes less resources -- Fixed Nextcloud sync issue when processing many items. -- Fixed: Handle case where file is left half-uploaded on Nextcloud instance (possibly an ocloud.de issue only) -- Fixed: Allow decryption of other items to continue even if an item cannot be decrypted -- Add Content-Size header for WebDAV, which is required by some services -- Fixed auto-title when title is manually entered first -- Improved auto-update process to avoid random crashes -- New: Allow focusing either title or body when creating a new note or to-do -- Fixed crash when having invalid UTF-8 string in text editor - -## [v0.10.52](https://github.com/laurent22/joplin/releases/tag/v0.10.52) - 2018-01-31T19:25:18Z - -- Optimised Nextcloud functionality so that it is faster and consumes less resources -- Fixed Nextcloud sync issue when processing many items. -- Fixed: Handle case where file is left half-uploaded on Nextcloud instance (possibly an ocloud.de issue only) -- Fixed: Allow decryption of other items to continue even if an item cannot be decrypted -- Add Content-Size header for WebDAV, which is required by some services -- Fixed auto-title when title is manually entered first -- Improved auto-update process to avoid random crashes -- New: Allow focusing either title or body when creating a new note or to-do - -## [v0.10.51](https://github.com/laurent22/joplin/releases/tag/v0.10.51) - 2018-01-28T18:47:02Z - -- Added Nextcloud support (Beta) -- Upgraded Electron to 1.7.11 to fix security vulnerability -- Fixed checkbox issue in config screen -- Fixed detection of encrypted item - -## [v0.10.48](https://github.com/laurent22/joplin/releases/tag/v0.10.48) - 2018-01-23T11:19:51Z - -- Improved and optimised file system sync target when many items are present. -- Fixes [#155](https://github.com/laurent22/joplin/issues/155): Caret alignment issue with Russian text -- Dutch translation (Thanks @tcassaert) -- Removed certain log statements so that sensitive info doesn't end up in logs -- Fix: Handle case where resource blob is missing during sync - ## [v0.10.47](https://github.com/laurent22/joplin/releases/tag/v0.10.47) - 2018-01-16T17:27:17Z - Improved the way new note are created, and automatically add a title. Made saving and loading notes more reliable. @@ -4089,5 +3974,54 @@ IMPORTANT: If you use Nextcloud it is recommended to sync all your notes before +## [v0.10.19](https://github.com/laurent22/joplin/releases/tag/v0.10.19) - 2017-11-20T18:59:48Z + + + +## [v0.10.31](https://github.com/laurent22/joplin/releases/tag/v0.10.31) - 2017-12-01T09:56:44Z + +- Fixes [#22](https://github.com/laurent22/joplin/issues/22) - keyboard cursor jumps while typing. + +## [v0.10.30](https://github.com/laurent22/joplin/releases/tag/v0.10.30) - 2017-11-30T20:28:16Z + +- Added Spanish locale (thank you Erick Rodríguez Ponce) +- Fixed copy/cut/paste issue in macOS +- Fixed checkbox issue in Option screen. + +## [v0.10.28](https://github.com/laurent22/joplin/releases/tag/v0.10.28) - 2017-11-30T01:07:46Z + +- Added toolbar to set alarms and attach files +- Fixed Evernote import of certain images +- Fixed note update issue + +## [v0.10.26](https://github.com/laurent22/joplin/releases/tag/v0.10.26) - 2017-11-29T16:02:17Z + +- Added support for alarms (notifications) +- Fixed scrolling issue for long notes +- Improved OneDrive login and possibly fixed rare error + +## [v0.10.25](https://github.com/laurent22/joplin/releases/tag/v0.10.25) - 2017-11-24T14:27:49Z + +- Allow multi-selection on note lists +- Allow drag and drop of notes +- Hide invalid characters (non-breaking spaces) in editor + + +## [v0.10.23](https://github.com/laurent22/joplin/releases/tag/v0.10.23) - 2017-11-21T19:38:41Z + + + +## [v0.10.22](https://github.com/laurent22/joplin/releases/tag/v0.10.22) - 2017-11-20T21:45:57Z + + + +## [v0.10.21](https://github.com/laurent22/joplin/releases/tag/v0.10.21) - 2017-11-18T00:53:15Z + + + +## [v0.10.20](https://github.com/laurent22/joplin/releases/tag/v0.10.20) - 2017-11-17T17:18:25Z + + + ## [v0.10.19](https://github.com/laurent22/joplin/releases/tag/v0.10.19) - 2017-11-20T18:59:48Z From b2e86d2f8a048c07c24c8ff005b7d9b252a24c55 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 22 Nov 2023 20:13:25 +0100 Subject: [PATCH 06/13] Update dependency @playwright/test to v1.39.0 (#9356) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- packages/app-desktop/package.json | 2 +- yarn.lock | 30 +++++++++++++++--------------- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/packages/app-desktop/package.json b/packages/app-desktop/package.json index 6865fdd4226..ac870c8d4aa 100644 --- a/packages/app-desktop/package.json +++ b/packages/app-desktop/package.json @@ -117,7 +117,7 @@ "devDependencies": { "@electron/rebuild": "3.3.0", "@joplin/tools": "~2.13", - "@playwright/test": "1.38.1", + "@playwright/test": "1.39.0", "@testing-library/react-hooks": "8.0.1", "@types/jest": "29.5.5", "@types/node": "18.18.8", diff --git a/yarn.lock b/yarn.lock index 919d84d1cd6..ce5d6236d1e 100644 --- a/yarn.lock +++ b/yarn.lock @@ -6220,7 +6220,7 @@ __metadata: "@joplin/renderer": ~2.13 "@joplin/tools": ~2.13 "@joplin/utils": ~2.13 - "@playwright/test": 1.38.1 + "@playwright/test": 1.39.0 "@testing-library/react-hooks": 8.0.1 "@types/jest": 29.5.5 "@types/mustache": 4.2.4 @@ -8486,14 +8486,14 @@ __metadata: languageName: node linkType: hard -"@playwright/test@npm:1.38.1": - version: 1.38.1 - resolution: "@playwright/test@npm:1.38.1" +"@playwright/test@npm:1.39.0": + version: 1.39.0 + resolution: "@playwright/test@npm:1.39.0" dependencies: - playwright: 1.38.1 + playwright: 1.39.0 bin: playwright: cli.js - checksum: c5ec0b23261fe1ef163b6234f69263bc10e7e5a3fb676c7773ffc70b87459a7ab225f57c03b9de649475771638a04c2e00d9b2739304a4dcf5d3edf20a7a4a82 + checksum: e93e58fc1af4239f239b890374f066c9a758e2492d25e2c1a532f3f00782ab8e7706956a07540fd14882c74e75f5de36273621adce9b79afb8e36e6c15f1d539 languageName: node linkType: hard @@ -32860,27 +32860,27 @@ __metadata: languageName: node linkType: hard -"playwright-core@npm:1.38.1": - version: 1.38.1 - resolution: "playwright-core@npm:1.38.1" +"playwright-core@npm:1.39.0": + version: 1.39.0 + resolution: "playwright-core@npm:1.39.0" bin: playwright-core: cli.js - checksum: 66e83fe040f309b13ad94ba39dea40ac207bfcbbc22de13141af88dbdedd64e1c4e3ce1d0cb070d4efd8050d7e579953ec3681dd8a0acf2c1cc738d9c50e545e + checksum: 556e78dee4f9890facf2af8249972e0d6e01a5ae98737b0f6b0166c660a95ffee4cb79350335b1ef96430a0ef01d3669daae9099fa46c8d403d11c623988238b languageName: node linkType: hard -"playwright@npm:1.38.1": - version: 1.38.1 - resolution: "playwright@npm:1.38.1" +"playwright@npm:1.39.0": + version: 1.39.0 + resolution: "playwright@npm:1.39.0" dependencies: fsevents: 2.3.2 - playwright-core: 1.38.1 + playwright-core: 1.39.0 dependenciesMeta: fsevents: optional: true bin: playwright: cli.js - checksum: 4e01d4ee52d9ccf75a80d8492829106802590721d56bff7c5957ff1f21eb3c328ee5bc3c1784a59c4b515df1b98d08ef92e4a35a807f454cd00dc481d30fadc2 + checksum: 96d8ca5aa25465c1c5d554d0d6071981d55e22477800ff8f5d47a53ca75193d60ece2df538a01b7165b3277dd5493c67603a5acda713029df7fbd95ce2417bc9 languageName: node linkType: hard From 0abaeef05e01a0f5e865df326c11129b2c471965 Mon Sep 17 00:00:00 2001 From: Joplin Bot Date: Thu, 23 Nov 2023 00:36:31 +0000 Subject: [PATCH 07/13] Doc: Auto-update documentation Auto-updated using release-website.sh --- readme/about/changelog/desktop.md | 164 +++++++++++++++++++++--------- 1 file changed, 115 insertions(+), 49 deletions(-) diff --git a/readme/about/changelog/desktop.md b/readme/about/changelog/desktop.md index 1f896d6391a..760eb3ea813 100644 --- a/readme/about/changelog/desktop.md +++ b/readme/about/changelog/desktop.md @@ -3845,6 +3845,121 @@ Note: This fixes an invalid database upgrade in the previous version. - Improved: Fixes [#268](https://github.com/laurent22/joplin/issues/268): Improve error message for invalid flags - Fix: Fixes [#271](https://github.com/laurent22/joplin/issues/271): Sort by created time was not respected +## [v1.0.70](https://github.com/laurent22/joplin/releases/tag/v1.0.70) - 2018-02-28T20:04:30Z + +- New: Resolves [#97](https://github.com/laurent22/joplin/issues/97): Export to JEX format or RAW format +- New: Import JEX and RAW format +- New: Resolves [#52](https://github.com/laurent22/joplin/issues/52): Import Markdown files or directory +- New: Allow sorting notes by various fields +- New: Resolves [#243](https://github.com/laurent22/joplin/issues/243): Added black and white tray icon for macOS +- Fix: [#247](https://github.com/laurent22/joplin/issues/247): Unreadable error messages when checking for updates +- Fix: Fixed sync interval sorting order +- Fix: [#256](https://github.com/laurent22/joplin/issues/256): Check that no other instance of Joplin is running before launching a new one + +## [v1.0.67](https://github.com/laurent22/joplin/releases/tag/v1.0.67) - 2018-02-19T22:51:08Z + +- Fixed: [#217](https://github.com/laurent22/joplin/issues/217): Display a message when the note has no content and only the note viewer is visible +- Fixed: [#240](https://github.com/laurent22/joplin/issues/240): Tags should be handled in a case-insensitive way +- Fixed: [#241](https://github.com/laurent22/joplin/issues/241): Ignore response for certain WebDAV calls to improve compatibility with some services. +- Updated: French and Español translation + +## [v1.0.66](https://github.com/laurent22/joplin/releases/tag/v1.0.66) - 2018-02-18T23:09:09Z + +- Fixed: Local items were no longer being deleted via sync. +- Improved: More debug information when WebDAV sync target does not work. +- Improved: Compatibility with some WebDAV services (Seafile in particular) + +## [v1.0.65](https://github.com/laurent22/joplin/releases/tag/v1.0.65) - 2018-02-17T20:02:25Z + +- New: Added several keyboard shortcuts +- New: Convert new lines in tables to BR tags, and added support for HTML tags in Markdown viewers +- Fixed: Confirmation message boxes, and release notes text +- Fixed: Issue with items not being decrypted immediately when they are created due to a sync conflict. +- Updated: Translations + +## [v1.0.64](https://github.com/laurent22/joplin/releases/tag/v1.0.64) - 2018-02-16T00:58:20Z + +Still more fixes and improvements to get v1 as stable as possible before adding new features. + +IMPORTANT: If you use Nextcloud it is recommended to sync all your notes before installing this release (see below). + +- Fixed: Nextcloud sync target ID (which was incorrectly set to WebDAV sync ID). As a result items that have been created since this bug will be re-synced with Nextcloud. This sync will not duplicate or delete any item but is necessary to preserve data integrity. IF YOU HAVE NOTES IN CONFLICT AFTER SYNC: Close the app completely and restart it to make sure all the lists are visually up-to-date. The notes in conflict most likely can be ignored - they are just duplicate of the real ones. To be safe, check the content but most likely they can simply be deleted. +- Improved: Provide Content-Length header for WebDAV for better compatibility with more servers +- Fixed: Allow copy and paste from config and encryption screen on macOS +- Fixed: [#201](https://github.com/laurent22/joplin/issues/201), [#216](https://github.com/laurent22/joplin/issues/216): Make sure only one update check can run at a time, and improved modal dialog boxes + +## [v1.0.63](https://github.com/laurent22/joplin/releases/tag/v1.0.63) - 2018-02-14T19:40:36Z + +- Improved the way settings are changed. Should also fixed issue with sync context being accidentally broken. +- Improved WebDAV driver compatibility with some services (eg. Seafile) + +## [v1.0.62](https://github.com/laurent22/joplin/releases/tag/v1.0.62) - 2018-02-12T20:19:58Z + +- Fixes [#205](https://github.com/laurent22/joplin/issues/205): Importing Evernote notes while on import page re-imports previous import +- Fixes [#209](https://github.com/laurent22/joplin/issues/209): Items with non-ASCII characters end up truncated on Nextcloud +- Added Basque translation, fixed issue with handling invalid translations. Updated translation FR. + +## [v0.10.61](https://github.com/laurent22/joplin/releases/tag/v0.10.61) - 2018-02-08T18:27:39Z + +- New: Display message when creating new note or to-do so that it doesn't look like the previous note content got deleted. +- New: Also support $ as delimiter for Katex expressions +- New: Added sync config check to config screens +- New: Allowing opening and saving resource images +- New: Toolbar button to set tags +- Update: Improved request repeating mechanism +- Fix: Make sure alarms and resources are attached to right note when creating new note +- Fix: Use mutex when saving model to avoid race conditions when decrypting and syncing at the same time + +## [v0.10.60](https://github.com/laurent22/joplin/releases/tag/v0.10.60) - 2018-02-06T13:09:56Z + +- New: WebDAV synchronisation target +- New: Support for math typesetting [Katex](https://khan.github.io/KaTeX/) +- New: Tray icon for Windows and macOS +- Fixed: Don't allow adding notes to conflict notebook +- Updated: Russian translation +- Updated: French translation +- New: List missing master keys in encryption screen +- Fixed: Attaching images in Linux was no longer working +- Fixed crash in macOS + +## [v0.10.54](https://github.com/laurent22/joplin/releases/tag/v0.10.54) - 2018-01-31T20:21:30Z + +- Optimised Nextcloud functionality so that it is faster and consumes less resources +- Fixed Nextcloud sync issue when processing many items. +- Fixed: Handle case where file is left half-uploaded on Nextcloud instance (possibly an ocloud.de issue only) +- Fixed: Allow decryption of other items to continue even if an item cannot be decrypted +- Add Content-Size header for WebDAV, which is required by some services +- Fixed auto-title when title is manually entered first +- Improved auto-update process to avoid random crashes +- New: Allow focusing either title or body when creating a new note or to-do +- Fixed crash when having invalid UTF-8 string in text editor + +## [v0.10.52](https://github.com/laurent22/joplin/releases/tag/v0.10.52) - 2018-01-31T19:25:18Z + +- Optimised Nextcloud functionality so that it is faster and consumes less resources +- Fixed Nextcloud sync issue when processing many items. +- Fixed: Handle case where file is left half-uploaded on Nextcloud instance (possibly an ocloud.de issue only) +- Fixed: Allow decryption of other items to continue even if an item cannot be decrypted +- Add Content-Size header for WebDAV, which is required by some services +- Fixed auto-title when title is manually entered first +- Improved auto-update process to avoid random crashes +- New: Allow focusing either title or body when creating a new note or to-do + +## [v0.10.51](https://github.com/laurent22/joplin/releases/tag/v0.10.51) - 2018-01-28T18:47:02Z + +- Added Nextcloud support (Beta) +- Upgraded Electron to 1.7.11 to fix security vulnerability +- Fixed checkbox issue in config screen +- Fixed detection of encrypted item + +## [v0.10.48](https://github.com/laurent22/joplin/releases/tag/v0.10.48) - 2018-01-23T11:19:51Z + +- Improved and optimised file system sync target when many items are present. +- Fixes [#155](https://github.com/laurent22/joplin/issues/155): Caret alignment issue with Russian text +- Dutch translation (Thanks @tcassaert) +- Removed certain log statements so that sensitive info doesn't end up in logs +- Fix: Handle case where resource blob is missing during sync + ## [v0.10.47](https://github.com/laurent22/joplin/releases/tag/v0.10.47) - 2018-01-16T17:27:17Z - Improved the way new note are created, and automatically add a title. Made saving and loading notes more reliable. @@ -3974,54 +4089,5 @@ Note: This fixes an invalid database upgrade in the previous version. -## [v0.10.19](https://github.com/laurent22/joplin/releases/tag/v0.10.19) - 2017-11-20T18:59:48Z - - - -## [v0.10.31](https://github.com/laurent22/joplin/releases/tag/v0.10.31) - 2017-12-01T09:56:44Z - -- Fixes [#22](https://github.com/laurent22/joplin/issues/22) - keyboard cursor jumps while typing. - -## [v0.10.30](https://github.com/laurent22/joplin/releases/tag/v0.10.30) - 2017-11-30T20:28:16Z - -- Added Spanish locale (thank you Erick Rodríguez Ponce) -- Fixed copy/cut/paste issue in macOS -- Fixed checkbox issue in Option screen. - -## [v0.10.28](https://github.com/laurent22/joplin/releases/tag/v0.10.28) - 2017-11-30T01:07:46Z - -- Added toolbar to set alarms and attach files -- Fixed Evernote import of certain images -- Fixed note update issue - -## [v0.10.26](https://github.com/laurent22/joplin/releases/tag/v0.10.26) - 2017-11-29T16:02:17Z - -- Added support for alarms (notifications) -- Fixed scrolling issue for long notes -- Improved OneDrive login and possibly fixed rare error - -## [v0.10.25](https://github.com/laurent22/joplin/releases/tag/v0.10.25) - 2017-11-24T14:27:49Z - -- Allow multi-selection on note lists -- Allow drag and drop of notes -- Hide invalid characters (non-breaking spaces) in editor - - -## [v0.10.23](https://github.com/laurent22/joplin/releases/tag/v0.10.23) - 2017-11-21T19:38:41Z - - - -## [v0.10.22](https://github.com/laurent22/joplin/releases/tag/v0.10.22) - 2017-11-20T21:45:57Z - - - -## [v0.10.21](https://github.com/laurent22/joplin/releases/tag/v0.10.21) - 2017-11-18T00:53:15Z - - - -## [v0.10.20](https://github.com/laurent22/joplin/releases/tag/v0.10.20) - 2017-11-17T17:18:25Z - - - ## [v0.10.19](https://github.com/laurent22/joplin/releases/tag/v0.10.19) - 2017-11-20T18:59:48Z From 2b9bf6deba587d69746cc5250ede7d2f283cb98a Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 24 Nov 2023 14:47:21 +0100 Subject: [PATCH 08/13] Update dependency @codemirror/autocomplete to v6.10.2 (#9352) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- packages/editor/package.json | 2 +- yarn.lock | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/packages/editor/package.json b/packages/editor/package.json index 477667d1131..fbb831fa48c 100644 --- a/packages/editor/package.json +++ b/packages/editor/package.json @@ -26,7 +26,7 @@ "typescript": "5.2.2" }, "dependencies": { - "@codemirror/autocomplete": "6.9.2", + "@codemirror/autocomplete": "6.10.2", "@codemirror/commands": "6.2.5", "@codemirror/lang-cpp": "6.0.2", "@codemirror/lang-html": "6.4.6", diff --git a/yarn.lock b/yarn.lock index ce5d6236d1e..f026c169ea2 100644 --- a/yarn.lock +++ b/yarn.lock @@ -3978,9 +3978,9 @@ __metadata: languageName: node linkType: hard -"@codemirror/autocomplete@npm:6.9.2": - version: 6.9.2 - resolution: "@codemirror/autocomplete@npm:6.9.2" +"@codemirror/autocomplete@npm:6.10.2": + version: 6.10.2 + resolution: "@codemirror/autocomplete@npm:6.10.2" dependencies: "@codemirror/language": ^6.0.0 "@codemirror/state": ^6.0.0 @@ -3991,7 +3991,7 @@ __metadata: "@codemirror/state": ^6.0.0 "@codemirror/view": ^6.0.0 "@lezer/common": ^1.0.0 - checksum: 8bdf06c2b4eb1cd6c8a6e1df2eb5c92011fda0bc8970f9d68cc8dad8e4f9d3c243aaa3e42505252af542be8bbaf0a3ed7e23a6b7f603171077cc36845e188190 + checksum: 360cea6a87ae9c4e3c996903f636a8f47f8ea6cd44504181e69dd8ccf666bad3e8cc6d8935e0eedd8aa118fdfe86ea78f41bc15288f3a7517dbb87115e057563 languageName: node linkType: hard @@ -6415,7 +6415,7 @@ __metadata: version: 0.0.0-use.local resolution: "@joplin/editor@workspace:packages/editor" dependencies: - "@codemirror/autocomplete": 6.9.2 + "@codemirror/autocomplete": 6.10.2 "@codemirror/commands": 6.2.5 "@codemirror/lang-cpp": 6.0.2 "@codemirror/lang-html": 6.4.6 From 3b15834e8d86b008d101669dd3c21e1f3e26ab42 Mon Sep 17 00:00:00 2001 From: Laurent Cozic Date: Fri, 24 Nov 2023 14:55:52 +0100 Subject: [PATCH 09/13] Tools: Check pull request titles --- .github/workflows/check-pr-title.yml | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 .github/workflows/check-pr-title.yml diff --git a/.github/workflows/check-pr-title.yml b/.github/workflows/check-pr-title.yml new file mode 100644 index 00000000000..4c24da5d047 --- /dev/null +++ b/.github/workflows/check-pr-title.yml @@ -0,0 +1,8 @@ +name: Check pull request title +on: [pull_request] +jobs: + main: + steps: + - uses: Slashgear/action-check-pr-title@v4.3.0 + with: + regexp: "(Desktop|Mobile|All|Cli|Tools|Chore|Clipper|Server|Android|iOS|Plugins): (Fixes|Resolves) #[0-9]+: .+" From 29b42b3b37e51fe22669402f88e4a711ccca01dd Mon Sep 17 00:00:00 2001 From: Laurent Cozic Date: Fri, 24 Nov 2023 16:10:23 +0100 Subject: [PATCH 10/13] CI: Add a comment when a pull request fail --- .github/workflows/comment-on-failure.yml | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 .github/workflows/comment-on-failure.yml diff --git a/.github/workflows/comment-on-failure.yml b/.github/workflows/comment-on-failure.yml new file mode 100644 index 00000000000..d3653ae794a --- /dev/null +++ b/.github/workflows/comment-on-failure.yml @@ -0,0 +1,13 @@ +on: + workflow_run: + workflows: + - Joplin Continuous Integration + - react-native-android-build-apk + - Build macOS M1 + types: [ completed ] + +jobs: + comment-failure: + runs-on: ubuntu-latest + steps: + - uses: quipper/comment-failure-action@v0.1.1 From 84cc1576a8507d6492fb02e1c68f026c2216ec4b Mon Sep 17 00:00:00 2001 From: Laurent Cozic Date: Fri, 24 Nov 2023 16:12:02 +0100 Subject: [PATCH 11/13] CI: Add a comment when a pull request fails --- .github/workflows/comment-on-failure.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/comment-on-failure.yml b/.github/workflows/comment-on-failure.yml index d3653ae794a..fbe8579df94 100644 --- a/.github/workflows/comment-on-failure.yml +++ b/.github/workflows/comment-on-failure.yml @@ -1,3 +1,4 @@ +name: comment-on-failure on: workflow_run: workflows: From 9930359210e9329b156cc0ce37f6b014ed025d21 Mon Sep 17 00:00:00 2001 From: Laurent Cozic Date: Fri, 24 Nov 2023 17:03:12 +0100 Subject: [PATCH 12/13] CI: Fix PR title script (#9366) --- .github/workflows/check-pr-title.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/check-pr-title.yml b/.github/workflows/check-pr-title.yml index 4c24da5d047..c8f94456602 100644 --- a/.github/workflows/check-pr-title.yml +++ b/.github/workflows/check-pr-title.yml @@ -2,7 +2,8 @@ name: Check pull request title on: [pull_request] jobs: main: + runs-on: ubuntu-latest steps: - uses: Slashgear/action-check-pr-title@v4.3.0 with: - regexp: "(Desktop|Mobile|All|Cli|Tools|Chore|Clipper|Server|Android|iOS|Plugins): (Fixes|Resolves) #[0-9]+: .+" + regexp: "(Desktop|Mobile|All|Cli|Tools|Chore|Clipper|Server|Android|iOS|Plugins|CI|Plugin Repo|Doc): (Fixes|Resolves) #[0-9]+: .+" From 62449998992d5068e48822e44a37ad8e49232892 Mon Sep 17 00:00:00 2001 From: Laurent Cozic Date: Fri, 24 Nov 2023 20:01:28 +0100 Subject: [PATCH 13/13] Doc: Document how to build and translate the help pages --- packages/doc-builder/README.md | 42 ++++++++++++++++------------------ 1 file changed, 20 insertions(+), 22 deletions(-) diff --git a/packages/doc-builder/README.md b/packages/doc-builder/README.md index aaba2fa1e16..d462d10194f 100644 --- a/packages/doc-builder/README.md +++ b/packages/doc-builder/README.md @@ -2,40 +2,38 @@ This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. -### Installation +## Development -``` -$ yarn -``` +### Generating the MDX files -### Local Development +From `packages/tools`, run `node website/processDocs.js --env dev` -``` -$ yarn start +### Getting the translations + +```shell +CROWDIN_PERSONAL_TOKEN=..... yarn crowdinDownload ``` -This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. +### Building the doc -### Build +From `packages/doc-builder`, run: -``` -$ yarn build +```shell +WEBSITE_BASE_URL=http://localhost:8077 yarn buildDev ``` -This command generates static content into the `build` directory and can be served using any static contents hosting service. +Or to build a particular locale: -### Deployment +```shell +WEBSITE_BASE_URL=http://localhost:8077 yarn buildDev --locale fr +``` -Using SSH: +`processDocs.js` will also build everything by default, but it takes a long time, so using the above commands is convenient for dev. -``` -$ USE_SSH=true yarn deploy -``` +## Translation -Not using SSH: +Translation is done using https://crowdin.com/ -``` -$ GIT_USER= yarn deploy -``` +## Building for production -If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. +This is done in `release-website.sh` from the repository https://github.com/joplin/website/