diff options
author | Bennett <hello@vantezzen.io> | 2020-04-17 20:50:37 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-04-17 19:50:37 +0100 |
commit | 0927dcbf4a8338150c61f91079a42a2ef96ec4ef (patch) | |
tree | e836a02110cd076c32b5e3eedfbe912f0d5f4c1e | |
parent | New Crowdin translations (#586) (diff) | |
download | ferdium-app-0927dcbf4a8338150c61f91079a42a2ef96ec4ef.tar.gz ferdium-app-0927dcbf4a8338150c61f91079a42a2ef96ec4ef.tar.zst ferdium-app-0927dcbf4a8338150c61f91079a42a2ef96ec4ef.zip |
Add 5.5.0-gm and 5.5.0 changelog (#574)
* Update README and CHANGELOG
* Add script to automatically link issues inside README.md
* Add #573 to README
* Add documentation for regex used in link-readme-issues script
* Fix linking for Franz issues
* Add linking for GitHub users
* Link more contributors
* Link more contributors
* Fix information about "npm run link-readme" command
* Add recipes to changelog
* Add 5.5.0 changelog
-rw-r--r-- | CHANGELOG.md | 86 | ||||
-rw-r--r-- | README.md | 34 | ||||
-rw-r--r-- | package.json | 3 | ||||
-rw-r--r-- | src/scripts/link-readme.js | 53 |
4 files changed, 165 insertions, 11 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index 49f6c5b67..9cd083904 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md | |||
@@ -1,3 +1,89 @@ | |||
1 | # [5.5.0](https://github.com/getferdi/ferdi/compare/v5.4.4-beta.3...v5.5.0) (2020-04-17) | ||
2 | ### Features | ||
3 | - Merge Franz 5.5.0-beta.2 | ||
4 | - Add dropdown list to choose Todo service (#418, #477), 💖 @yourcontact | ||
5 | - Add hotkey for darkmode (#530, #537), 💖 @Room4O4 & @mahadevans87 | ||
6 | - Add option to start Ferdi minimized (#490, #534) | ||
7 | - Add option to show draggable window area on macOS (#304, #532) | ||
8 | - Add support for Adaptable Dark Mode on Windows (#548), 💖 @Room4O4 & @mahadevans87 | ||
9 | - Add notification & audio toggle action in tray context menu (#542), 💖 @Room4O4 & @mahadevans87 | ||
10 | - Add Dark Reader settings (#531, #568), 💖 @Room4O4 & @mahadevans87 | ||
11 | - Add support for 11 new services and improve existing ones, 💖 @rctneil @JakeSteam @sampathBlam @tpopela @RoiArthurB | ||
12 | - Add support for unlocking with Touch ID (#367) | ||
13 | - Add find in page feature (#67) (#432) | ||
14 | - Add custom dark mode handler support (#445) | ||
15 | - Add option to disable reload after resume (#442), 💖 @n0emis | ||
16 | - Add custom JS/CSS to services (#83) | ||
17 | - Add ability to change the services icons size and sidebar width (#153) | ||
18 | |||
19 | ### Minor changes | ||
20 | - Improve user onboarding (#493) | ||
21 | - Improve "Updates" section in settings (#506), 💖 @yourcontact | ||
22 | - Improve information about Franz Premium and Teams | ||
23 | - Hide user lastname on Ferdi servers as it is not stored | ||
24 | - Improve draggable window area height for macOS (#304, #479) | ||
25 | - Remove server setting from settings screen (#516), 💖 @mrassili | ||
26 | - Update Electron to 8.1.1 (#480) | ||
27 | - Window title now reflects service name (#213), 💖 @gmarec | ||
28 | - Improve system tray icon behaviour (#307) | ||
29 | - Improve navigation bar behaviour setting (#270) | ||
30 | - Ferdi is now available as Flatpak on Flathub (#323), 💖 @lhw | ||
31 | - Add automatic local recipe updates | ||
32 | - Add option to start Ferdi in system tray (#331), 💖 @jereksel | ||
33 | - Add better support for macOS dark mode | ||
34 | - Add better seperation in settings | ||
35 | - Change Sentry telemetry to be opt-in only (#160) | ||
36 | |||
37 | ### Bug fixes | ||
38 | - Fix cache clearing not working in Windows 10 (#541, #544), 💖 @Room4O4 & @mahadevans87 | ||
39 | - Fix Home button in navigation bar not correctly navigating (#571, #573), 💖 @Room4O4 & @mahadevans87 | ||
40 | - Fix and enhance context menu (#357) (#413) (#452) (#354) (#227) | ||
41 | - Fix regresssion around muting services (#428), 💖 @dpeukert | ||
42 | - Fix app unusable without an account on Windows since v5.4.0 (#253) | ||
43 | - Fix services URL validation/harmonization (#276) | ||
44 | - Fix app failing to properly lock itself at startup resulting in shortcuts not working (#377) (#362) | ||
45 | - Fix shortcuts not working when locked (#404) | ||
46 | - Fix missing Slack services custom icons (#290) | ||
47 | - Fix app possibly unusable when using faulty translations (#340) | ||
48 | - Fix Dark Mode setting on Windows (#347) | ||
49 | - Fix login problems in Google services | ||
50 | - Fix DarkReader blocking services from loading (#285) | ||
51 | - Fix incorrect body closing tag (#330), 💖 @jereksel | ||
52 | |||
53 | ### Build changes | ||
54 | - Add retry commands to flaky build steps (#498) | ||
55 | - Run utility scripts pre-commit instead of pre-push (#515) | ||
56 | |||
57 | ## [5.5.0-gm](https://github.com/getferdi/ferdi/compare/v5.4.4-beta.3...v5.5.0-gm) (2020-04-15) | ||
58 | ### Features | ||
59 | - Merge Franz 5.5.0-beta.2 | ||
60 | - Add dropdown list to choose Todo service (#418, #477), 💖 @yourcontact | ||
61 | - Add hotkey for darkmode (#530, #537), 💖 @Room4O4 & @mahadevans87 | ||
62 | - Add option to start Ferdi minimized (#490, #534) | ||
63 | - Add option to show draggable window area on macOS (#304, #532) | ||
64 | - Add support for Adaptable Dark Mode on Windows (#548), 💖 @Room4O4 & @mahadevans87 | ||
65 | - Add notification & audio toggle action in tray context menu (#542), 💖 @Room4O4 & @mahadevans87 | ||
66 | - Add Dark Reader settings (#531, #568), 💖 @Room4O4 & @mahadevans87 | ||
67 | - Add support for 11 new services and improve existing ones, 💖 @rctneil @JakeSteam @sampathBlam @tpopela @RoiArthurB | ||
68 | |||
69 | ### Minor changes | ||
70 | - Improve user onboarding (#493) | ||
71 | - Improve "Updates" section in settings (#506), 💖 @yourcontact | ||
72 | - Improve information about Franz Premium and Teams | ||
73 | - Improve user scripts (#559) | ||
74 | - Hide user lastname on Ferdi servers as it is not stored | ||
75 | - Improve draggable window area height for macOS (#304, #479) | ||
76 | - Remove server setting from settings screen (#516), 💖 @mrassili | ||
77 | - Update Electron to 8.1.1 (#480) | ||
78 | |||
79 | ### Bug fixes | ||
80 | - Fix cache clearing not working in Windows 10 (#541, #544), 💖 @Room4O4 & @mahadevans87 | ||
81 | - Fix Home button in navigation bar not correctly navigating (#571, #573), 💖 @Room4O4 & @mahadevans87 | ||
82 | |||
83 | ### Build changes | ||
84 | - Add retry commands to flaky build steps (#498) | ||
85 | - Run utility scripts pre-commit instead of pre-push (#515) | ||
86 | |||
1 | # [5.4.3](https://github.com/getferdi/ferdi/compare/v5.4.0...v5.4.3) | 87 | # [5.4.3](https://github.com/getferdi/ferdi/compare/v5.4.0...v5.4.3) |
2 | ### Features | 88 | ### Features |
3 | - Add inactivity lock #179 | 89 | - Add inactivity lock #179 |
@@ -124,6 +124,7 @@ If you use an AUR Helper e.g. yay, simply install it via `yay -S ferdi`. | |||
124 | - [x] Adds CTRL+← and CTRL+→ shortcuts and menu options to go back and forward in the service browsing history([#39](https://github.com/getferdi/ferdi/issues/39)) | 124 | - [x] Adds CTRL+← and CTRL+→ shortcuts and menu options to go back and forward in the service browsing history([#39](https://github.com/getferdi/ferdi/issues/39)) |
125 | - [x] Adds "Scheduled Do-not-Disturb" feature in which you won't get notifications (similar to Rambox's [Work Hours](https://rambox.pro/#feature-details/work_hours)) | 125 | - [x] Adds "Scheduled Do-not-Disturb" feature in which you won't get notifications (similar to Rambox's [Work Hours](https://rambox.pro/#feature-details/work_hours)) |
126 | - [x] Allows you to [use any Todo service inside "Franz Todo" panel](https://github.com/getferdi/ferdi/wiki/Custom-Todo) (e.g. Todoist via https://todoist.com/app) instead of being limited to using Franz Todo | 126 | - [x] Allows you to [use any Todo service inside "Franz Todo" panel](https://github.com/getferdi/ferdi/wiki/Custom-Todo) (e.g. Todoist via https://todoist.com/app) instead of being limited to using Franz Todo |
127 | - [x] Adds a dropdown list to choose your Todo service ([#418](https://github.com/getferdi/ferdi/issues/418), [#477](https://github.com/getferdi/ferdi/issues/477)), 💖 [@yourcontact](https://github.com/yourcontact) | ||
127 | 128 | ||
128 | ### Adds features to improve your privacy | 129 | ### Adds features to improve your privacy |
129 | - [x] [Adds option to change server to a custom](https://github.com/getferdi/ferdi/wiki/Custom-Server) [ferdi-server](https://github.com/getferdi/server) | 130 | - [x] [Adds option to change server to a custom](https://github.com/getferdi/ferdi/wiki/Custom-Server) [ferdi-server](https://github.com/getferdi/server) |
@@ -137,20 +138,28 @@ If you use an AUR Helper e.g. yay, simply install it via `yay -S ferdi`. | |||
137 | 138 | ||
138 | ### Adds features to improve your experience using Ferdi | 139 | ### Adds features to improve your experience using Ferdi |
139 | - [x] Adds Universal Dark Mode via the [DarkReader extension](https://github.com/darkreader/darkreader) ([#71](https://github.com/getferdi/ferdi/issues/71)) | 140 | - [x] Adds Universal Dark Mode via the [DarkReader extension](https://github.com/darkreader/darkreader) ([#71](https://github.com/getferdi/ferdi/issues/71)) |
140 | - [x] Adds adaptable Dark Mode that will respect the system's Dark Mode setting ([#173](https://github.com/getferdi/ferdi/issues/173)) | 141 | - [x] Adds Dark Reader settings ([#531](https://github.com/getferdi/ferdi/issues/531), [#568](https://github.com/getferdi/ferdi/issues/568)), 💖 [@Room4O4](https://github.com/Room4O4) & [@mahadevans87](https://github.com/mahadevans87) |
142 | - [x] Adds adaptable Dark Mode that will respect the system's Dark Mode setting ([#173](https://github.com/getferdi/ferdi/issues/173), [#548](https://github.com/getferdi/ferdi/issues/548) (💖 [@Room4O4](https://github.com/Room4O4) & [@mahadevans87](https://github.com/mahadevans87))) | ||
143 | - [x] Adds a hotkey to quickly toggle darkmode ([#530](https://github.com/getferdi/ferdi/issues/530), [#537](https://github.com/getferdi/ferdi/issues/537)), 💖 [@Room4O4](https://github.com/Room4O4) & [@mahadevans87](https://github.com/mahadevans87) | ||
144 | - [x] Adds an option to start Ferdi minimized ([#490](https://github.com/getferdi/ferdi/issues/490), [#534](https://github.com/getferdi/ferdi/issues/534)) | ||
141 | - [x] Adds ability to change the services icons size and sidebar width ([#153](https://github.com/getferdi/ferdi/issues/153)) | 145 | - [x] Adds ability to change the services icons size and sidebar width ([#153](https://github.com/getferdi/ferdi/issues/153)) |
142 | - [x] Adds an option to auto-hide the menubar ([#7](https://github.com/getferdi/ferdi/issues/7), [franz#833](https://github.com/meetfranz/franz/issues/833)) | 146 | - [x] Adds an option to auto-hide the menubar ([#7](https://github.com/getferdi/ferdi/issues/7), [franz#833](https://github.com/meetfranz/franz/issues/833)) |
143 | - [x] Enhances system tray icon behaviour ([#307](https://github.com/getferdi/ferdi/issues/307)) | 147 | - [x] Enhances system tray icon behaviour ([#307](https://github.com/getferdi/ferdi/issues/307)) |
148 | - [x] Adds option to show draggable window area on macOS ([#304](https://github.com/getferdi/ferdi/issues/304), [#532](https://github.com/getferdi/ferdi/issues/532)) | ||
149 | - [x] Adds a notification & audio toggle action to the tray context menu ([#542](https://github.com/getferdi/ferdi/issues/542)), 💖 [@Room4O4](https://github.com/Room4O4) & [@mahadevans87](https://github.com/mahadevans87) | ||
144 | - [x] Adds option to show a browser-like navigation bar on all services | 150 | - [x] Adds option to show a browser-like navigation bar on all services |
145 | - [x] Adds option to change accent color | 151 | - [x] Adds option to change accent color |
146 | - [x] Reflects your currently opened service name to the window title to improve support for Password Managers ([#213](https://github.com/getferdi/ferdi/issues/213)) | 152 | - [x] Reflects your currently opened service name to the window title to improve support for Password Managers ([#213](https://github.com/getferdi/ferdi/issues/213)), 💖 [@gmarec](https://github.com/gmarec) |
147 | - [x] Allows using SVGs for service custom icon | 153 | - [x] Allows using SVGs for service custom icon |
148 | - [x] Adds button to open darkmode.css for a service | 154 | - [x] Adds button to open darkmode.css for a service |
149 | - [x] Improves "About Ferdi" screen to better display versions | 155 | - [x] Improves "About Ferdi" screen to better display versions |
150 | - [x] Adds option to start Ferdi in system tray ([#331](https://github.com/getferdi/ferdi/issues/331)) | 156 | - [x] Improves user onboarding ([#493](https://github.com/getferdi/ferdi/issues/493)) |
151 | - [x] Fixes and enhances context menu (#357 #413 #452 #354 #227) | 157 | - [x] Improves "Updates" section in settings ([#506](https://github.com/getferdi/ferdi/issues/506)), 💖 [@yourcontact](https://github.com/yourcontact) |
158 | - [x] Improves draggable window area height for macOS ([#304](https://github.com/getferdi/ferdi/issues/304), [#479](https://github.com/getferdi/ferdi/issues/479)) | ||
159 | - [x] Adds option to start Ferdi in system tray ([#331](https://github.com/getferdi/ferdi/issues/331)), 💖 [@jereksel](https://github.com/jereksel) | ||
160 | - [x] Fixes and enhances context menu ([#357](https://github.com/getferdi/ferdi/issues/357) [#413](https://github.com/getferdi/ferdi/issues/413) [#452](https://github.com/getferdi/ferdi/issues/452) [#354](https://github.com/getferdi/ferdi/issues/354) [#227](https://github.com/getferdi/ferdi/issues/227)) | ||
152 | - [x] Adds better support for macOS dark mode | 161 | - [x] Adds better support for macOS dark mode |
153 | - [x] Adds option to disable reload of services after resuming Ferdi ([#442](https://github.com/getferdi/ferdi/issues/442)) | 162 | - [x] Adds option to disable reload of services after resuming Ferdi ([#442](https://github.com/getferdi/ferdi/issues/442)), 💖 [@n0emis](https://github.com/n0emis) |
154 | - [x] Comes with a custom branding proper to Ferdi | 163 | - [x] Comes with a custom branding proper to Ferdi |
155 | - [x] Adds better separation in settings | 164 | - [x] Adds better separation in settings |
156 | - [x] Adds various other UI improvements | 165 | - [x] Adds various other UI improvements |
@@ -163,19 +172,24 @@ If you use an AUR Helper e.g. yay, simply install it via `yay -S ferdi`. | |||
163 | - [x] Fixes missing Slack services custom icons ([#290](https://github.com/getferdi/ferdi/issues/290)) | 172 | - [x] Fixes missing Slack services custom icons ([#290](https://github.com/getferdi/ferdi/issues/290)) |
164 | - [x] Fixes bug that marked valid domains as invalid ([#276](https://github.com/getferdi/ferdi/issues/276)) | 173 | - [x] Fixes bug that marked valid domains as invalid ([#276](https://github.com/getferdi/ferdi/issues/276)) |
165 | - [x] Fixes microphone/camera access on some versions of macOS ([#193](https://github.com/getferdi/ferdi/issues/193)) | 174 | - [x] Fixes microphone/camera access on some versions of macOS ([#193](https://github.com/getferdi/ferdi/issues/193)) |
175 | - [x] Fixes cache clearing not working in Windows 10 ([#541](https://github.com/getferdi/ferdi/issues/541), [#544](https://github.com/getferdi/ferdi/issues/544)), 💖 [@Room4O4](https://github.com/Room4O4) & [@mahadevans87](https://github.com/mahadevans87) | ||
176 | - [x] Fixes Home button in navigation bar not correctly navigating ([#571](https://github.com/getferdi/ferdi/issues/571), [#573](https://github.com/getferdi/ferdi/issues/573)), 💖 [@Room4O4](https://github.com/Room4O4) & [@mahadevans87](https://github.com/mahadevans87) | ||
166 | 177 | ||
167 | ### Adds new platforms | 178 | ### Adds new platforms |
168 | - [x] Adds portable version for Windows so you can use Ferdi without even installing it | 179 | - [x] Adds portable version for Windows so you can use Ferdi without even installing it, 💖 [@Makazzz](https://github.com/Makazzz) |
169 | - [x] Adds Arch Linux AUR packages | 180 | - [x] Adds Arch Linux AUR packages, 💖 [@AGCaesar](https://github.com/AGCaesar) |
170 | - [x] Adds Ferdi as a Flatpak on Flathub ([#323](https://github.com/getferdi/ferdi/issues/323)) | 181 | - [x] Adds Ferdi as a Flatpak on Flathub ([#323](https://github.com/getferdi/ferdi/issues/323)), 💖 [@lhw](https://github.com/lhw) |
171 | 182 | ||
172 | ### Adds internal changes | 183 | ### Adds internal changes |
173 | - [x] Upgrades to Electron 8 | 184 | - [x] Upgrades to Electron 8.1.1 |
174 | - [x] Switches to [`electron-spellchecker`](https://github.com/electron-userland/electron-spellchecker) to improve application size | 185 | - [x] Switches to [`electron-spellchecker`](https://github.com/electron-userland/electron-spellchecker) to improve application size |
175 | - [x] Minifies build files to improve app size | 186 | - [x] Minifies build files to improve app size |
176 | - [x] Adds "npm run prepare-code" command for development to lint and beautify code | 187 | - [x] Adds "npm run prepare-code" command for development to lint and beautify code |
177 | - [x] Fixes incorrect body closing tag ([#330](https://github.com/getferdi/ferdi/issues/330)) | 188 | - [x] Adds "npm run link-readme" command to automatically add links to issues and users inside README.md |
189 | - [x] Fixes incorrect body closing tag ([#330](https://github.com/getferdi/ferdi/issues/330)), 💖 [@jereksel](https://github.com/jereksel) | ||
178 | - [x] Uses CrowdIn to improve i18n | 190 | - [x] Uses CrowdIn to improve i18n |
191 | - [x] Adds retry commands to flaky build steps ([#498](https://github.com/getferdi/ferdi/issues/498)) | ||
192 | - [x] Runs utility scripts pre-commit instead of pre-push ([#515](https://github.com/getferdi/ferdi/issues/515)) | ||
179 | 193 | ||
180 | > Thanks to all our [contributors](#contributors-) who helped realize all these amazing features! 💖 | 194 | > Thanks to all our [contributors](#contributors-) who helped realize all these amazing features! 💖 |
181 | 195 | ||
diff --git a/package.json b/package.json index becd0d227..2da8f6b9d 100644 --- a/package.json +++ b/package.json | |||
@@ -32,7 +32,8 @@ | |||
32 | "apply-branding": "node ./src/i18n/apply-branding.js", | 32 | "apply-branding": "node ./src/i18n/apply-branding.js", |
33 | "update-submodules": "git submodule update --remote --force && git add .", | 33 | "update-submodules": "git submodule update --remote --force && git add .", |
34 | "prepare-code": "npm run update-submodules && npm run lint && npm run reformat-files && npm run manage-translations && npm run apply-branding", | 34 | "prepare-code": "npm run update-submodules && npm run lint && npm run reformat-files && npm run manage-translations && npm run apply-branding", |
35 | "build-theme-info": "node src/scripts/build-theme-info.js" | 35 | "build-theme-info": "node src/scripts/build-theme-info.js", |
36 | "link-readme": "node src/scripts/link-readme.js" | ||
36 | }, | 37 | }, |
37 | "keywords": [], | 38 | "keywords": [], |
38 | "author": "Amine Mouafik <amine@mouafik.fr>", | 39 | "author": "Amine Mouafik <amine@mouafik.fr>", |
diff --git a/src/scripts/link-readme.js b/src/scripts/link-readme.js new file mode 100644 index 000000000..223451d84 --- /dev/null +++ b/src/scripts/link-readme.js | |||
@@ -0,0 +1,53 @@ | |||
1 | /** | ||
2 | * Script that automatically creates links to issues and users inside README.md | ||
3 | * | ||
4 | * e.g. "#123" => "[#123](https://github.com/getferdi/ferdi/issues/123)" | ||
5 | * and "franz/#123" => "[franz#123](https://github.com/meetfranz/franz/issues/123)" | ||
6 | * and "@abc" => "[@abc](https://github.com/abc)" | ||
7 | */ | ||
8 | |||
9 | const fs = require('fs-extra'); | ||
10 | const path = require('path'); | ||
11 | |||
12 | console.log('Linking issues and PRs in README.md'); | ||
13 | |||
14 | const readmepath = path.join(__dirname, '../../', 'README.md'); | ||
15 | |||
16 | // Read README.md | ||
17 | let readme = fs.readFileSync(readmepath, 'utf-8'); | ||
18 | |||
19 | let replacements = 0; | ||
20 | |||
21 | // Replace Ferdi issues | ||
22 | // Regex matches strings that don't begin with a "[", i.e. are not already linked and | ||
23 | // don't begin with "franz", i.e. are not Franz issues, followed by a "#" and 3 digits to indicate | ||
24 | // a GitHub issue, and not ending with a "]" | ||
25 | readme = readme.replace(/(?<!\[|franz)#\d{3}(?!\])/gi, (match) => { | ||
26 | const issueNr = match.replace('#', ''); | ||
27 | replacements += 1; | ||
28 | return `[#${issueNr}](https://github.com/getferdi/ferdi/issues/${issueNr})`; | ||
29 | }); | ||
30 | |||
31 | // Replace Franz issues | ||
32 | // Regex matches strings that don't begin with a "[", i.e. are not already linked | ||
33 | // followed by a "franz#" and 3 digits to indicate | ||
34 | // a GitHub issue, and not ending with a "]" | ||
35 | readme = readme.replace(/(?<!\[)franz#\d{3,}(?!\])/gi, (match) => { | ||
36 | const issueNr = match.replace('franz#', ''); | ||
37 | replacements += 1; | ||
38 | return `[franz#${issueNr}](https://github.com/meetfranz/franz/issues/${issueNr})`; | ||
39 | }); | ||
40 | |||
41 | // Link GitHub users | ||
42 | // Regex matches strings that don't begin with a "[", i.e. are not already linked | ||
43 | // followed by a "@" and at least one word character and not ending with a "]" | ||
44 | readme = readme.replace(/(?<!\[)@\w+(?!\])/gi, (match) => { | ||
45 | const username = match.replace('@', ''); | ||
46 | replacements += 1; | ||
47 | return `[@${username}](https://github.com/${username})`; | ||
48 | }); | ||
49 | |||
50 | // Write to file | ||
51 | fs.writeFileSync(readmepath, readme); | ||
52 | |||
53 | console.log(`Added ${replacements} strings`); | ||