Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release notes improvements #212

Open
tooomm opened this issue Jan 21, 2021 · 7 comments
Open

Release notes improvements #212

tooomm opened this issue Jan 21, 2021 · 7 comments

Comments

@tooomm
Copy link
Contributor

tooomm commented Jan 21, 2021

Most users have auto update enabled and don't review/check all changes.

Due to the Release Notes only showing the most recent change(s), features or important changes are easily missed:
Untitled

It would be helpful to have a Changelog with version numbers and some simple history there like:

 - v1.7.1 [2021-01-15]
     - Show correct icon for draft PRs

 - v1.7.0 [2020-04-07]
    - Update badge counter when opening notification
    - Option to hide badge

 - v1.6.3 [2020-03-03]
    - Fix popup populating for real now

 ...

Or a link to a changelog file or e.g. the GitHub Releases page or the Mozilla Add-On version history

 - v1.7.1 [2021-01-15]
     - Show correct icon for draft PRs

 For a complete version history and changes in older versions see: xxxx
@freaktechnik
Copy link
Owner

Thanks for the suggestion.

I don't like changelogs where you don't know exactly what changed in your current version because they just list a bunch of versions (unless there are unreleased/partially release versions since the last change).

However having a link to the full changelog might be an interesting idea.

@tooomm
Copy link
Contributor Author

tooomm commented Jan 21, 2021

you don't know exactly what changed in your current version because they just list a bunch of versions

The list of changes in Release Notes should have the currently used version on top and don't show any changes in newer versions that are not installed/used.


However having a link to the full changelog might be an interesting idea.

Another wording could be:

Changes in v1.7.1 [2021-01-15]:

  - Show correct icon for draft PRs

For a complete version history and changes in other versions check: xxxx

@tooomm
Copy link
Contributor Author

tooomm commented Jan 21, 2021

I saw you added a link to the AMO version history already. 👍

And thanks for the contributor update. :)

@tooomm
Copy link
Contributor Author

tooomm commented Jun 23, 2021

I saw you added a link to the AMO version history already. 👍

This is gone now again. Only the most recent change is displayed and one has no easy way to catch up on former changes.

With v1.8.0 I only get this now:
180

It used to have a link to https://addons.mozilla.org/en-GB/firefox/addon/advanced-github-notifier/versions/.

@freaktechnik
Copy link
Owner

Yes, I didn't add the link in the 1.8.0 release notes. I have to add it to every version manually if I want it to be there. And honestly I'm mostly waiting on the upstream fix for it (one day I might be tempted to do that one myself if it doesn't move at all)

@freaktechnik
Copy link
Owner

It seems I haven't linked the upstream bug here yet, it's https://bugzilla.mozilla.org/show_bug.cgi?id=1688045

@tooomm
Copy link
Contributor Author

tooomm commented Jun 23, 2021

I have to add it to every version manually if I want it to be there. And honestly I'm mostly waiting on the upstream fix for it (one day I might be tempted to do that one myself if it doesn't move at all)

Makes totally sense!

Thanks for taking care of the bug report (and linking it). 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants