Open Bug 1688045 Opened 5 years ago Updated 3 years ago

Link to Version History from Release Notes

Categories

(Toolkit :: Add-ons Manager, enhancement, P5)

Desktop
All
enhancement

Tracking

()

People

(Reporter: freaktechnik, Unassigned, Mentored)

Details

Add a link at the bottom of the Release Notes tab that links to the "Version History" of an extension on AMO (<listing URL>/versions) with a label like "Visit the Version History for past releases" or similar.

This would allow users to quickly find out what has happened not just in the latest version, which might just be a small bug fix release. If the user has auto updates enabled, they are likely to have missed a bunch of versions.

Of course some extensions explicitly inform the user about new features in a version. An add-on author can also manually add such a link in every changelog they write.

However, I'd argue that this is a universally useful feature that shouldn't require extension authors remembering to add some copy for every version they release. Especially, since the copy is only for the add-on manager, and not for the "Version History" where all the versions are already shown, but the same text is used.

This is inspired by an issue reported on one of my extensions: https://github.com/freaktechnik/advanced-github-notifier/issues/212

Mentor: mixedpuppy
Severity: -- → N/A
Keywords: good-first-bug
Priority: -- → P5

To get started, please read our onboarding documentation at https://wiki.mozilla.org/WebExtensions/Contribution_Onramp.

Hi
Can I work on this bug?

Abhishek

Hi Abhishek, welcome! Yes, you can work on this bug. Use the documentation from Comment #1 to set up your dev environment. We'll assign you to this issue once you submit a PR. :)

If you have any specific questions, please feel welcome to needinfo the mentor for this issue (:mixedpuppy).

Happy bug fixing!

A couple of additional details that may be useful (after the dev environment is ready) to know:

Feel free to ask to the mentor assigned to this bug any question may help you to clean doubts that are likely to arise once you looked to the source code and documentation listed above.

Hey,
I am new to bugfixing, may I know the status of this bug, if possible I would like to work on this

Hi James, welcome! Let's give Abhishek some more time to work on this before we open it up to other contributors. :)

In the meantime, would you be interested in working on one of our other good-first-bugs? You can find other good-first-bugs for this component at https://mzl.la/2VXBaqe and we also have a number of good-first-bugs for the WebExtensions API at https://mzl.la/2yq1XA8.

To get started, check out our onboarding documentation at https://wiki.mozilla.org/WebExtensions/Contribution_Onramp.

(In reply to Caitlin Neiman [:caitmuenster] from comment #6)

Hi James, welcome! Let's give Abhishek some more time to work on this before we open it up to other contributors. :)

In the meantime, would you be interested in working on one of our other good-first-bugs? You can find other good-first-bugs for this component at https://mzl.la/2VXBaqe and we also have a number of good-first-bugs for the WebExtensions API at https://mzl.la/2yq1XA8.

To get started, check out our onboarding documentation at https://wiki.mozilla.org/WebExtensions/Contribution_Onramp.

Hi Caitlin,
Thanks for the guidance, I'll trynna find some new bug to work on, I am added on the mailing list on this bug, plz let me know if you decide to open it up for other contributors.

Hi
I setup the dev environment but can you explain AMO (<listing URL>/versions) ?

Flags: needinfo?(mixedpuppy)

Hi Abhishek,
I'm looking into what we'll need to do to support this, I'll get back later.
Shane

Hi, I filed an issue [1] to expose the "Version History" URL in the API response. This should be available on -prod in a week.

[1] https://github.com/mozilla/addons-server/issues/16534

Hi, the AMO API now exposes a versions_url field in the response for a given add-on (API docs here).

Hi Abhishek,
Are you still interested in working on this? needinfo me again if you are and I'll get you some pointers to start with. It's a little (not a lot) more involved since we'll also need to support the new versions_url that was added so we could do this.
Regards,
Shane

Flags: needinfo?(mixedpuppy) → needinfo?(mick.sharma02)

Hi , i am new to open source. this bug can be a good start for me. Can you assign this bug to me?

Hi kalyan, welcome! Abhishek was just pinged about this, so let's give him a few days to respond.

If you want to try another good-first-bug, you can find a list of current issues at https://mzl.la/2yq1XA8. Any of these issues that hasn't had activity for more than two weeks is open. :) We'll assign you once you submit a PR for review.

Happy bug fixing!

Hi Neiman
Sorry for late response. Can I work on this issue.

Flags: needinfo?(mick.sharma02)

Hi Abhishek, go for it! We'll assign you once you submit a PR.

Thanks Neiman
I do it.

Hi, my name is Leslie and I'm an Outreachy applicant. May I work on this bug?

Flags: needinfo?(mixedpuppy)

Hi Leslie, you can work on this bug! Can you send me an email (cneiman@mozilla.com) to let me know what Outreachy project you're interested in applying for? I want to make sure that you're contributing to bugs that will help develop a relationship with the project mentor. :)

Flags: needinfo?(mixedpuppy)

(In reply to Shane Caraveo (:mixedpuppy) from comment #12)

needinfo me again if you are and I'll get you some pointers to start with. It's a little (not a lot) more involved since we'll also need to support the > new versions_url that was added so we could do this.

Hi Shane, I have set up my dev environment, could I get those pointers to start on?
I am also confused about AMO (<listing URL>/versions) . Could you explain what that is?

Flags: needinfo?(mixedpuppy)

Hi Leslie,

I am also confused about AMO (<listing URL>/versions) . Could you explain what that is?

In the api call made to get the data for an addon there is a new versions_url field which is a link to a webpage on AMO.

For example, the api call https://addons.mozilla.org/api/v4/addons/addon/firefox-color/ now contains versions_url which has the link to https://addons.mozilla.org/en-US/firefox/addon/firefox-color/versions/

What we need to do is add a link on the release notes page that uses that (versions_url) to allow a user to open the full release history on AMO.

I have set up my dev environment, could I get those pointers to start on?

While researching this again so I can remember what needs to be done, it seems like there is some rather complex aspects to how we do things. Depending on how comfortable you are with digging into very old and complex code (still javascript) I may have to just give you some of the code changes in some of the lower level and keep you focused on the UI portion of the changes. In retrospect, this is not the best "good-first-bug".

I'll keep the ni? for me and come back to this after the weekend.

Thank you so much for the clarification, makes more sense to me now.

While researching this again so I can remember what needs to be done, it seems like there is some rather complex aspects to how we do things. Depending on how comfortable you are with digging into very old and complex code (still javascript) I may have to just give you some of the code changes in some of the lower level and keep you focused on the UI portion of the changes. In retrospect, this is not the best "good-first-bug".

I'll keep the ni? for me and come back to this after the weekend.

Let me know what you think is best in regards to me tackling it.

Hey Leslie, I'm so sorry for the delayed response -- unfortunately we haven't had the time to think through the approach to this bug!

Since we may not be able to look into this one soon, would you be interested in finding a different good-first-bug to work on?

Flags: needinfo?(lesore0789)

Removing the 'good-first-bug' keyword from this bug per comment #22.

Flags: needinfo?(mixedpuppy)
Flags: needinfo?(lesore0789)
Keywords: good-first-bug
You need to log in before you can comment on or make changes to this bug.