Skip to content

Changelog

v1.3.1

This release batches highlights to Readwise into multiple requests if you are trying to send more than 2000 requests at a time.

If you're trying to upload a large batch of highlights in one go, this should now be possible without the risk of the Readwise API rejecting the request due to it being too large.

v1.3.0

This release refactors all of the internal logging, dropping zerolog in favour of trusty logrus which is not user facing at all.

As a result, logging now works properly again on Windows closing #25

While going through all the various log entries, I've also switched the logging format to JSON which makes it easier to parse through each file. Some log entry sizes have also been greatly reduced where before they would log out an entire struct even if the whole thing wasn't useful. This should greatly reduce the size of the average log file.

In order to making it easier for users to submit logs for investigations, there is now a button in the Settings view that will open your computer's file explorer to the location that October stores logs in (#12)

Windows windows-logs

macOS macos-log

You might also notice a couple of other small additions in the screenshots above.

There is now a little build identifier in the Settings view where you can see build information about the version of October you're running (#65) as well as a button for reporting bugs which will open a new Github issue pre-populated with said build information to make it easier to provide support to end users.

I've still got some other refactoring tasks to do which should hopefully then make it easier to add in some of the larger features that have been outstanding such as better handling of upload failures as well as cutting down the time to upload

v1.2.0

This release does not contain any new features but tidies up a lot of underlying metadata associated with each executable, thanks in part to a bunch of upgrades that were introduced with Wails 2.0, the Go framework that powers Wails.

NOTE: For Windows users, I recommend uninstalling October before installing this latest version just to avoid any confusion. Nothing will break if you decide not to but as some metadata has changed, using the latest installer will change the install location resulting in two October entries. You can install the older version at any point but it may be confusing if you aren't aware of this change. I figure best to do it now than wait until it might impact more users in future.

At a high level, this update corrects the version information that is available in various places as well as adding some publisher information and other things that you would generally not need to be aware of but can be handy.

I don't expect this to be that interesting to most users but if you'd like to read the nitty gritty details, feel free to keep reading:

Windows

Install path

Publisher information has been set to utf9k which is just the sort of "catch all" that I use for my software side projects and happens to be the domain of my website as well.

This in itself isn't particularly interesting but it does inform the installation path for October so for Windows users, October is now installed at C:\Program Files\utf9k\October\october.exe. Before this change, it was installed at C:\Program Files\October\October\october.exe.

While I don't distribute any other Windows software, this just helps with grouping it all together in a standard place in line with how Windows expects applications to be laid out.

installer-name

In order to remove the previous version, you can either run the uninstaller located at C:\Program Files\October\October\uninstall.exe or you can use the Add or remove programs section in Control Panel. You'll be able to spot the proper version as all versions before this one will show with the version set as 1.0.0

uninstall

This only needs to be done one time as future installations of October will always be installed at C:\Program Files\utf9k\October going forward.

Version information

Something I hadn't realised until it was mentioned in #65 is that there isn't actually a clear way at all to identify version information. This still has some work to be done, such as surfacing it within October itself but now there are a few places that can be checked to see what version you are using.

NOTE: Due to limitations in how versions are laid out, they are always represented as x.x.x where x is a number regardless of any extra versioning. For example, both 1.2.2-alpha1 and 1.2.2-beta2 would be represented as 1.2.2 due to what Windows (and installer files) expect. That said, I don't expect any users to actually run any pre-release versions as they're most for my own testing to simulate what the final release may look like.

The first place that is updated is Add or remove programs which now reflects the installed version, in this case 1.2.0. It also reflects an updated publisher name as well.

installed-compare

Right clicking on the October executable and selecting Properties -> Details will also show relevant versioning information as well.

windows

If there are any other Windows metadata areas that I'm not aware of and have missed, please let me know.

macOS

Historically the macOS app has had a little "About October" popup that is accessible from the application menu, as is standard with all macOS applications.

CleanShot 2022-11-27 at 15 30 32@2x

We can do better than that though and there is now extra metadata visible when viewing October.app within your Applications folder:

Right clicking on the application and selecting "Get Info" will now show a bunch of updated information such as the installed version.

CleanShot 2022-11-27 at 15 06 56@2x

Similarly, pressing Spacebar with October.app highlighted will also show a bunch of information using Finder's preview functionality

CleanShot 2022-11-27 at 15 06 38@2x

There aren't any other relevant areas of macOS that I'm aware of to check as applications are very self contained (ie; there isn't a messy install process) unlike with Windows and as such, there is no need to worry about install paths changing or anything like that.

v1.1.2

This is a minor update to fix an edge case that some users have run into in the past.

While Readwise does not impose any limits on how many highlights you can have, there is a system limit that highlights can't be any longer than 8191 characters long.

Generally speaking, if you're making highlights that long, you're missing the point of highlights but I've seen occasional reports of Kobo highlighting accidentally capturing an entire chapter.

Without this being obvious to the end user, they'll be confused when October appears to fail (as any error will cause the upload process to fail currently) so it's better to work around this issue than cause 99% of valid highlights to fail to upload I think.

The real fix for this is to delete those highlights on your device (find the highlight, tap it and hit delete) but for users who might want to make such long highlights for whatever reason, October will now split your highlight text into appropriate chunks.

v1.1.1

This version adds a fallback for highlights that are missing the DateCreated field, which causes October to fail to continue processing.

In the event that DateCreated is missing, October will use the DateModified field. If both are somehow missing, it'll do a further fallback and use the current date.

v1.1.0

This release brings quite a few changes although a lot of them are under the hood so you won't notice them but they'll make it easier to add new features to October going forward.

Codesigning on Windows

First of all, October for Windows is now codesigned meaning there should no longer be any scary warnings going forward. As this version is the first to be codesigned, and my developer certificate is now, Windows SmartScreen is expected to appear for a brief period of time while trust is established against October but once that's done, new releases should no longer trigger a warning. You can read more about this addition in this announcement

Internal refactoring

As mentioned, a lot of changes have happened under the hood. October is powered by Wails and while understanding how to use the latest version, I rearranged the internals of the project and the latest iteration ended up with everything being a bit too far apart resulting in duplicate code and other things. Without boring you with the details, everything is now "closer together" making it easier to do changes going forward.

The frontend now also uses Vite and with that comes live reloading which means any developer changes will recompile the application. This means it becomes much faster to test out changes (and ultimately to release them as well!)

Support for unreleased Kobo devices

Under the hood, October uses pgaskin/koboutils which currently has support for all released Kobo devices. At one point however, it did not and it may lag behind when new devices are refreshly released. October effectively just uses koboutils to get metadata about devices so I've updated the device selector to allow you to select unrecognised Kobos instead of just ignoring them.

unknownkobo

Condensed settings

The Settings page has been condensed a little bit and the Readwise token link will now actually open that window in your browser whereas before it was just a piece of text.

settings

In future, I'd like to add the ability to both export and view system logs from within October itself for any advanced users who might like to try and diagnose their own issues.

Updated toasts

The library I was using for toasts wasn't the nicest so I've swapped out react-toastify for react-hot-toast which has cut down on a bunch of code. As a result, toasts now appear at the top of the screen and take up much less space visually.

toast

What's next

As you'll notice, there wasn't much new in this release as a lot of it was spent on things behind the scenes. I think October is in a good spot to start extending out the UI so users have much more control over highlight uploading instead of just a big sync button.

As a bit of a teaser, here's a screenshot of something I threw together in a short period of time. I was starting straight on a v2 but I decided it's better (and safer) to do things piece by piece rather than doing a big bang release that may ultimately introduce more bugs. Admittedly, doing the best thing isn't as fun though.

v2

This isn't necessarily what an updated October might look like but while this is using an email template, it is rendering real data from my Kobo that was connected to my computer. Ideally if one highlight fails, it shouldn't cause your entire upload process to be blocked so that's something I'd like to move towards next.

v1.0.2

This release updated Windows binaries to be built with CGO_ENABLED=1. Without it, Windows builds failed to be usable end to end. They should work properly now.

v1.0.1

This was a minor fix for an issue that was blocking October from compiling.

v1.0.0

BREAKING CHANGE: A one time breaking change was made where additional metadata is submitted to Readwise. This resulted in any books uploaded pre-1.0.0 with October being duplicated. This change was used to properly match books on your device so covers aren't overwritten in future.

This release marked the first official release of October, as far as stability and error handling.

It added the ability to upload cover images to Readwise and a button for checking connectivity with Readwise (ie; is your token valid)

v0.9.4-post2

This release disables upx as it can cause some unforseen issues. I haven't witnessed them but I'd like to avoid them all the same.

v0.9.4-post1

Nothing new with this release but Windows builds are now installed via a NSIS installer.

As a result of this, users now have a desktop icon and start menu entry upon installation as well.

As always, please submit any feedback via Github Issues

v0.9.4

This release fixes up an issue with Windows builds not working. As a result of adding logging, I didn't realise that zap doesn't initialize properly on Windows.

I've implemented a workaround and it seems to be working fine.

The README has also been tidied up with some Windows information and screenshots.

v0.9.3

This release unlocks the previous hard requirement on books having a title. Sideloaded books with no title will now firstly fallback to extracting the epub filename.

For example, if you have a book like cool author - interesting book.epub, your Readwise "book" will be called cool author - interesting book. If that fails somehow, it will fall back again to just omitting the title/sending an empty string.

What Readwise will do then is creating a "book" called "Quotes".

NOTE: While you can change the title of your book in Readwise, this will cause future uploads to reduplicate highlights under the old title. For now, if you can leave the titles as is, I'll attempt to address this shortly.

As always, please let me know if you have any issues so I can add them to my v1.0.0 backlog.

v0.9.2

This release adds basic logging in the following places. It's good enough for providing support but is intended to be cleaned up (and exporting via the UI) before v1.0.0 releases.

October should save logs in the following places:

Windows: %APPDATA%\Local\october\logs macOS: $HOME/Library/Application Support/october/logs Linux: /usr/local/share/october/logs

v0.9.1

This release doesn't add anything new functionality wise but sets up a build pipeline that does the following:

  • Builds Windows + macOS binaries
  • Zips up Windows .exes
  • Notarises macOS .app and packages it up as a mountable dmg
  • This means no more quarantining of the macOS app

v0.9.0

This is the first public release of October. It's marked as v0.9.0 as while it works end to end, the codebase is a bit messy. People are free to use it but shouldn't expect it to be "released" until v1.0.0.

I also need to set up proper CI/CD infrastructure so excuse the bare .app files zipped up for now.

Additionally, I intend to codesign October so you don't need to fiddle with the security settings.