|
1 | 1 | # Zulip-terminal Changelog |
2 | 2 |
|
| 3 | +## 0.7.0 - 20 May 2022 |
| 4 | + |
| 5 | +This long-awaited release includes contributions from our four 2021 |
| 6 | +[GSoC](https://summerofcode.withgoogle.com/) students, though as with recent |
| 7 | +releases we welcomed those from |
| 8 | +[many](https://github.com/zulip/zulip-terminal/graphs/contributors?from=2021-01-29&to=2022-05-20&type=c) |
| 9 | +others - many thanks to you all for making this a great release! |
| 10 | + |
| 11 | +<!-- Highlight summary - increasing feature parity --> |
| 12 | +This release features an extension of the existing autocomplete infrastructure |
| 13 | +to handle viewing, autocompletion and validation of private message recipients, |
| 14 | +dramatically improving the user experience in this area. Another major feature |
| 15 | +is application of arbitrary reactions to messages, which was previously limited |
| 16 | +to :+1:. Those interacting with more visual communities may find the ability to |
| 17 | +download and open attachments particularly useful. |
| 18 | + |
| 19 | +<!-- Highlight summary - terminal-specific --> |
| 20 | +Other than these and other changes for growing parity with existing Zulip |
| 21 | +clients and later Zulip server versions, we continue to explore |
| 22 | +terminal-specific features such as improved layout designs, and ideas such as |
| 23 | +sender presence markers adjacent to each message. |
| 24 | + |
| 25 | +### IMPORTANT NOTES |
| 26 | + |
| 27 | +#### Python versions (CPython 3.6-3.10, PyPy 3.6-3.9) |
| 28 | + |
| 29 | +As noted in the release notes for 0.6.0, this release depends on a minimum of |
| 30 | +python 3.6 (see #838, #567) since 3.5 was dropped upstream some time ago. Testing |
| 31 | +against CPython 3.10 and a wider range of PyPy Python versions was added in CI |
| 32 | +(#1132, #1141, #1159). |
| 33 | + |
| 34 | +This is highly likely to be the last release with support for python 3.6, for |
| 35 | +which support has now ended upstream (see #984). |
| 36 | + |
| 37 | +#### Footlinks settings (#773, #841) |
| 38 | + |
| 39 | +The previous `footlinks` setting for configuring footlinks now has adjusted |
| 40 | +behavior if enabled (the default), to show only the first 3 per message; the |
| 41 | +full set can be found in the Message Information popup (<kbd>i</kbd>). |
| 42 | + |
| 43 | +In future this previous setting is expected to be phased out in favor of the |
| 44 | +new `maximum-footlinks` setting, where `0` corresponds to `footlinks=disabled` |
| 45 | +and `3` represents the new `footlinks=enabled` behavior. |
| 46 | + |
| 47 | +#### Customized installs |
| 48 | + |
| 49 | +If you've customized your install by editing themes or keys, be sure to back |
| 50 | +these up before upgrading and then carefully integrate them. **This is |
| 51 | +particularly important in this release since themes are now structured differently |
| 52 | +in the codebase (see the new `themes/THEME_CONTRIBUTING.md`)** |
| 53 | + |
| 54 | +### HIGHLIGHTS |
| 55 | + |
| 56 | +- Message composition has great new features! |
| 57 | + - Private message recipients show sender names, may be autocompleted, and are validated |
| 58 | + - Autocomplete topic links like `#**some stream>exciting topic**` |
| 59 | + - Check your content markdown by comparing with examples via <kbd>meta(alt)</kbd>-<kbd>m</kbd> |
| 60 | + - Narrow to conversations you're just starting using <kbd>meta(alt)</kbd>-<kbd>.</kbd> |
| 61 | +- More useful message actions! |
| 62 | + - Apply arbitrary reactions to messages via <kbd>:</kbd>, like in the web app |
| 63 | + - Download and open attachments directly from ZT |
| 64 | + - Open a message in the local web browser, for those features ZT doesn't yet handle |
| 65 | +- More useful information! |
| 66 | + - Indicate the presence status of the sender of each message in the central list of messages |
| 67 | + - More information available for streams, messages, and now also for users via <kbd>i</kbd> |
| 68 | +- Improved behavior for smaller terminals! |
| 69 | + - Popups can be wider on narrower (80-100 character) terminals, showing eg. all of help text |
| 70 | + - Autohide mode now overlays the side panels, which shrink to mini-panels to indicate their presence |
| 71 | + - View long messages in scrollable popup windows |
| 72 | +- Theme support improves! |
| 73 | + - Syntax highlighting of code blocks via pygments |
| 74 | + - Contributions of new themes should be much simpler - eg. `gruvbox_light` added already |
| 75 | + - Support for 24-bit colors |
| 76 | + |
| 77 | +### Interactivity improvements |
| 78 | +- Message actions: |
| 79 | + - Support downloading of media (attachments) and opening in default viewers (#1223, #1058, #740, #359) |
| 80 | + - Support adding arbitrary reactions to a message using <kbd>:</kbd> (#559, #707, #913) |
| 81 | + - Support renaming of messages with topic set to "(no topic)" (topicless messages) (#837, #946) |
| 82 | + - Allow editing messages when there is no time limit on edits (#1034, #1035) |
| 83 | + - Support opening a selected message in a web-browser (#397, #698, #991) |
| 84 | + - Give more information text when messages are moved between topics (#1172, #1178, #1196) |
| 85 | +- Message composition: |
| 86 | + - Private message composition now shows the user name and supports autocompletion (#587, #877) |
| 87 | + - During private message sender autocomplete, name/email pairs are validated and tidied (#937) |
| 88 | + - During mention autocomplete, use user id's to distinguish between users with identical names (#151, #928) |
| 89 | + - Support autocomplete of topics in composing message content (#1004) |
| 90 | + - Properly handle spaces in autocomplete of mentions (#925, #1004) |
| 91 | + - Avoid cycling to stream name when editing stream messages (#870, #1161) |
| 92 | + - Add Markdown formatting help popup, accessed using <kbd>meta(alt)</kbd>-<kbd>m</kbd> (#623, #1025) |
| 93 | + - Notify the user if a message is sent/edited outside the current narrow (#781, #824) |
| 94 | + - Support narrowing to the current compose narrow using <kbd>meta(alt)</kbd>-<kbd>.</kbd> (#1182, #1194, #1206) |
| 95 | + - Use new `urwid-readline` feature and server parameters to limit typing long messages on the client side (#996) |
| 96 | + - Only send private message typing notifications if the setting is enabled on the server (#1136, #1163) |
| 97 | +- General UI: |
| 98 | + - Indicate and update the number of starred messages in the top left UI area (#578, #951) |
| 99 | + - Indicate and update the presence status of the sender of each message in the central list of messages (#896, #987) |
| 100 | + - Toggle display of new User Information popup from user list using <kbd>i</kbd> (#511, #848) |
| 101 | +- Options/configuration: |
| 102 | + - Added `--notify` and `--no-notify` command-line options to override the `notify` config file setting (#964) |
| 103 | + - Support update of per-stream notification setting during session, including from Stream Information popup (#900, #1080) |
| 104 | +- System notifications: |
| 105 | + - Hide content of private messages if this setting is enabled on the server (#1166) |
| 106 | + - Hide spoiler content in all message notifications (#1173) |
| 107 | +- Fetch organization custom emoji cleanly at startup and update them during each session (#809, #827) |
| 108 | + |
| 109 | +### Visual improvements |
| 110 | +- Popups continue to show more information: |
| 111 | + - Links within topic names (eg. linkifiers) are shown in the Message Information popup (#709, #867) |
| 112 | + - Show year of message posting in Message Information popup (#879, #930) |
| 113 | + - Stream descriptions in the Stream Information popup now support any markdown included that is rendered in messages (#743, #749) |
| 114 | + - Stream Information popup has various other fixes and additional information available (#880, #1127, #1119, #1165) |
| 115 | +- Message rendering: |
| 116 | + - If fewer than 4 users react to a message, their names are shown instead of a count (#1212, #1213) |
| 117 | + - Improved math text (katex) rendering (#1024) |
| 118 | + - Improved rendering of nested quotes (#942) |
| 119 | + - Heading titles in message markdown is now styled differently to main text (#1095, #1146) |
| 120 | +- Improved behavior for smaller terminals: |
| 121 | + - Automatically scale popup widths better on narrower (80-100 character) terminals (#1018) |
| 122 | + - Autohide mode now indicates which panels are closed with a few labelled columns (#1097) |
| 123 | + - Autohide mode now overlays the side panels rather than 'squashing' the window (#1100) |
| 124 | + - View any (particularly long) messages in scrollable popup windows, showing rendered or raw formatting (#874, #543) |
| 125 | +- Themes have been restructured, making contribution simpler (#1051, #1160, #1167): |
| 126 | + - Syntax highlighting of code blocks via pygments (#1012) |
| 127 | + - 24-bit colors may be specified in colors used in themes (#998, #1051) |
| 128 | + - A new gruvbox_light theme is available (#1144, #1176) |
| 129 | + - Gruvbox themes are updated to use only colors from the official suggested palettes for dark and light modes (#1176) |
| 130 | +- Indicate web-public streams differently (#712, #1135, #1177) |
| 131 | +- Respect user preference on server regarding 12- or 24-hour time rendering (#917, #770) |
| 132 | +- Emphasize borders and text at top of sections (#952) |
| 133 | +- Add categories of footer notifications, with different styling (#782, #971) |
| 134 | +- Indent topic list appropriately to take into account space for any resolved-topic marker (#1124) |
| 135 | + |
| 136 | +### Important bugfixes |
| 137 | +- Fix errors when both reactions and message read/star status are changed for uncached messages (#920, #1162) |
| 138 | +- Always start a new prefilled composition when using <kbd>x</kbd> or <kbd>c</kbd> (#871, #947, #960) |
| 139 | +- Remove unstarred messages from starred narrow upon leaving narrow (#940, #943) |
| 140 | +- Avoid crash when entering an empty stream or topic search list; show feedback instead (#923, #977) |
| 141 | +- Allow draft to be accessed (focused) when cursor was in the side panels (#1044) |
| 142 | +- Maintain position in stream/topic lists before and after searches (#975, #978) |
| 143 | +- Fix behavior where narrowing to another message within the same narrow failed (#954, #967) |
| 144 | +- Fix failure to support editing only message content on later servers, by tracking original topic (#1056) |
| 145 | +- Improve consistency of mouse scroll speed in side panels (#1082) |
| 146 | +- Display hint in footer on attempting to select text in any area of the screen, not just a message (#1085) |
| 147 | +- Only create `debug.log` file in current directory if in debug mode (#1066, #1122) |
| 148 | +- Avoid sending and showing typing notifications from yourself (#1011) |
| 149 | +- Improve tracking of topic message ids when message topics are edited (#1130) |
| 150 | +- Include wildcard mentions (eg. `@all`, `@everyone`, `@stream`) in mentions narrow (#1037, #1038) |
| 151 | +- Avoid rapid repeated help hints, by updating footer only if it does not have the same text (#647, #748) |
| 152 | +- Correctly indicate stream markers on editing stream messages (eg. private streams) (#1181) |
| 153 | + |
| 154 | +### User documentation updates |
| 155 | +- New documentation: |
| 156 | + - README section added to indicate where updates are announced (#1031) |
| 157 | + - New User Tutorial added as `docs/getting-started.md` (#922, #221) |
| 158 | + - Hot keys documentation is now generated automatically from the source, in `docs/hotkeys.md` (#926, #126, #941) |
| 159 | + - Clarify intentional design choices where different from webapp (#1224, #547) |
| 160 | +- FAQ-related updates: |
| 161 | + - New FAQ entry regarding issues running with Windows Terminal (#955) |
| 162 | + - Indicate that we specifically wish to scale from 80x24 rows**x**columns upwards and add a FAQ entry for how best to work at smaller widths (#1007) |
| 163 | + - Improved FAQ section regarding rendering symbols, with new `zulip-term-check-symbols` to test each for debugging (#979) |
| 164 | + - Add section to FAQ regarding how autocomplete works (#1017) |
| 165 | +- Indicate possibility of `-h`/`--help` option in README (#1170) |
| 166 | + |
| 167 | +### Infrastructure improvements |
| 168 | +- Automatically format codebase with `black` (#1039, #1087, #1092) |
| 169 | +- Migrate development branch from `master` to `main` (#891) |
| 170 | +- Various changes enabled by the new minimum python version of 3.6+: |
| 171 | + - type comments to inline type annotations (#910, #901) |
| 172 | + - prefer f-strings (eg. #949) |
| 173 | +- Development documentation: |
| 174 | + - Commit style notes split out into an expanded section of README (#1055) |
| 175 | + - Add notes on using auto-formatting tools (#1192) |
| 176 | +- GitHub Pull Request template added (#1071) |
| 177 | +- Type annotations added to many tests, few now remain (eg. #1076, #1077, #1083, #1091, #1096, #1099, #1102, #1105, #1125) |
| 178 | +- Use updated mypy with external packages for type stubs (#1131) |
| 179 | +- Finalized migration away from hardcoded keys (#953, #469, #533, #539) |
| 180 | +- Improved platform handling code, particularly appropriate to supporting WSL (#1059) |
| 181 | +- Migrated to send and retain `user_id` for message composition as per updated API (#1006) |
| 182 | +- Improved debug experience by saving all `print()` output to `debug.log` without requiring flush (#1122) |
| 183 | +- Updated user and development dependencies (#1179) |
| 184 | +- Reduce redundancy by redirecting `Pipfile` to `setup.py` and removing `requirements.txt` (#936) |
| 185 | +- Add `check-branch` tool to ensure independence of commits in a branch (#1214) |
| 186 | + |
3 | 187 | ## 0.6.0 - 28 January 2021 |
4 | 188 |
|
5 | 189 | This release contains the second set of contributions from our two 2020 |
|
0 commit comments