auto-tab-discard
auto-tab-discard copied to clipboard
rNeomy
Please keep a Changelog/Release Notes
First of all, thank you for developing this amazing extension, it makes my computer so much more responsive.
My Firefox just opened this URL, which I assume it's a way of telling me that it's been updated from 0.3.5.2 to 0.3.6. But on that page I can't see what changed between these versions, so I came to GitHub, and didn't find a release notes document not any GitHub Releases or git tags.
It would be great if you could keep a Changelog. I use this format for my own projects, but you could also use GitHub Releases feature.
Thanks!
It is on the page from the URL you put in the Issue. Look at bullet 4
What's new in this version? Please check the Logs section.
https://add0n.com/tab-discard.html#log-container
Would be nice if it was in the repo as well, but there is a history here: https://addons.mozilla.org/en-CA/firefox/addon/auto-tab-discard/versions/
@warthurton When navigating to that link, the comment section immediately expands and pushes all of that information way down the page.
I didn't realize this at first, so I assumed section was missing and there were just comments, because expanding comment sections are almost always the last thing on a page.
That's exactly what happened Inverness. The comment section is usually at the end of a page so I assumed there was no other content on that page.
I do like a brief summary changes to be visible at a glance at about:addons i.e.
That said, I'm equally happy with a link out from about:addons to a log, if the log is suitably clear.
As an example, https://github.com/dessant/search-by-image/issues/104 drew attention to https://github.com/dessant/search-by-image/compare/v3.1.0...v3.4.1 and the developer chose to link out:
– to a more user-friendly log i.e. https://github.com/dessant/search-by-image/blob/master/CHANGELOG.md#341-2020-11-23
Version 0.4.0 was released (and auto-updated), but it's not mentioned in https://github.com/dessant/search-by-image/blob/master/CHANGELOG.md and https://add0n.com/tab-discard.html?version=0.4.0&p=0.3.7&type=update shows "No release note found for current version!"
https://addons.mozilla.org/addon/auto-tab-discard/versions/ shows 0.3.7 (2020-07-18) rising to 0.4.0 yesterday (2021-02-02).
Given https://github.com/rNeomy/auto-tab-discard/commits/master, the change log for 0.4.0 might be viewed as:
- https://github.com/rNeomy/auto-tab-discard/compare/658babb4bb67448d1dbf960727e693a7ffd4601f...46c01116a65ad00db95caf5447c414c0e8741af7
Gentle bump @rNeomy please, can you make it habit to provide release notes? I always like to see notes before deciding whether to allow an update. Thanks.
https://github.com/rNeomy/auto-tab-discard/issues/205#issuecomment-784780523 🏆
In the meantime, if I understand correctly, for 0.4.0–0.4.1.1 it's:
- https://github.com/rNeomy/auto-tab-discard/compare/46c01116a65ad00db95caf5447c414c0e8741af7...a2138f31dd9f63808dd792da83d64ff51cf24410
@grahamperrin this is what I get on the FAQs page.
The FAQs page uses AMO's log API. So it might take some time for it to update.
AMO's log API.
OK, now I see the underlying issue. I assumed, wrongly, that notes had not been provided to AMO.
They're present, but not translated:
- https://addons.mozilla.org/en-US/firefox/addon/auto-tab-discard/versions/0.4.1.1/updateinfo/ has notes
- https://addons.mozilla.org/en-GB/firefox/addon/auto-tab-discard/versions/0.4.1.1/updateinfo/ is empty
– and so, emptiness within Firefox:
People with Firefox set to a US locale will probably find notes very quickly at about:addons in Firefox – without the delays that might be associated with add0n.com
https://add0n.com/tab-discard.html#log-container reviewed in Firefox 86.0 release candidate 3 following a cache-free reload:
No release note found for current version!
In a different browser, the notes do appear.
Back to Firefox, there's a workaround to the problem with add0n.com:
- about:preferences#general
- Choose your preferred language for displaying pages ▶ Choose…
- add English (United States) [en-us], if it's not already listed
- move the non-preferred language to the top of the list
- OK
- revisit https://add0n.com/tab-discard.html#log-container
- perform a simple reload
- revisit about:preferences#general
- end the United States pretence
- OK
– after which a load or reload of https://add0n.com/tab-discard.html#log-container will revert to presenting false information :-(
Step (4) above:
That's wired! Based on the network log, the FAQs page has a script to fetch https://addons.mozilla.org/api/v3/addons/addon/%7Bc2c003ee-bd69-42a2-b0e9-6f34222cb046%7D/versions/ to get the log info. This API is not localized but keeps the changelogs in all languages. There is a script on the page to display the first available localized log. So I am not sure how you get the No release note found for current version! message
From https://github.com/rNeomy/auto-tab-discard/issues/163#issuecomment-650273230:
… addons.mozilla.org/en-CA/firefox/addon/auto-tab-discard/versions
Yep, that /en-CA/ page includes information, as does /en-US/ https://addons.mozilla.org/en-US/firefox/addon/auto-tab-discard/versions/ however https://addons.mozilla.org/en-GB/firefox/addon/auto-tab-discard/versions/ does not.
https://addons.mozilla.org/en-CA/firefox/addon/auto-tab-discard/versions/0.4.8/updateinfo/