Skip to content

Latest commit

 

History

History
109 lines (70 loc) · 5.14 KB

retiring-your-extension.md

File metadata and controls

109 lines (70 loc) · 5.14 KB
layout title description permalink topic tags contributors last_updated_by date
sidebar
Retiring your extension
Learn the correct process for retiring your Firefox extension. Follow best practices to notify users and remove your add-on gracefully.
/documentation/manage/retiring-your-extension/
Manage
manage
end-of-life
rebloor
rebloor
2019-03-22 23:22:00 -0700

{% capture page_hero_banner_content %}

Retiring your extension

There may be occasions where you want to retire one of your extensions. This article outlines the steps to follow and offers suggestions for a suitable timeline.

{% endcapture %} {% include modules/page-hero.liquid, content: page_hero_banner_content %}

{% capture content_with_toc %}

Reasons for withdrawing an extension

There are two main reasons why you might want to end-of-life your extension:

  • You plan to remove support for a product or service. In this case, you should remove the extension from browsers when support ends.

  • You’re replacing the extension with a new one, which isn’t a direct upgrade. In this case, you’ll want to encourage existing users to install the new extension before removing the old one from their browsers.

{% endcapture %} {% include modules/column-w-toc.liquid, id: "reasons-for-withdrawing" content: content_with_toc %}

{% capture content %}

Steps to retiring an extension

When you want to withdraw an extension, consider taking these steps:

  1. Devise a timetable for your extension’s end-of-life. Consider including these steps:

    1. publish your extension’s end-of-life timetable, including an explanation of why you’re retiring your extension.
    2. publish an update that removes installed copies of your extension.
    3. make the extension unavailable for new installs.

  2. Publish advice that you’re planning to end-of-life your extension. Consider these options to advise people of your intention to take down your extension:

    1. update your extension’s page on addons.mozilla.org (AMO) with its end-of-life timetable.
    2. if your extension is being superseded, provide a link to the new extension. You can use management.onInstalled to listen for the installation of the new extension and then trigger the removal of the original extension using management.uninstallSelf.
    3. communicate the timetable through social media, forums, or, where possible, by email.

  3. Publish a final, self-removing version of your extension. Use management.uninstallSelf() to cause your extension to uninstall itself. Before it does, provide a notice reminding the user about the removal of the extension. If your extension is superseded, provide a reminder about the link to the new extension. You might offer the user the option to remove the extension now or in a few days.

    The sunset-extension example illustrates one approach to the content for a final version of your extension.

  4. Make your AMO listing invisible to prevent new installs. To hide your extension’s AMO listing:

    1. open your extension’s listing in AMO.
    2. from the sidebar menu, open Manage Status & Versions.
    3. in the Listing Visibility section, click Invisible.

    Your hidden extension is not listed in AMO searches or accessible using the page’s AMO URL.

{% endcapture %} {% include modules/one-column.liquid, id: "steps-to-retiring-an-extension" content: content %}

{% capture content %}

Suggested retirement timetable

There is no ideal period between publication of your end-of-life timetable and the removal of your extension from users’ browsers. In setting the timetable, consider:

  • if you’re not providing a replacement extension, you can have a relatively short notice period, perhaps a couple of weeks.

  • if you’re replacing the extension with an alternative version, you may wish to provide a longer notice period, with regular reminders about the new extension. In this case, you might want to leave weeks or months between the initial end-of-life advice and the final removal of installed copies.

When you’ve started retiring the extension, use the active user statistics on AMO to fine-tune your timing. For example, if the number of active users isn’t declining significantly, you may want to delay deployment of your extension’s final version and send out a reminder about your plans. To access the active user statistics, open your extension in the AMO Developer Hub and click View Statistics Dashboard on the shortcut menu.

{% endcapture %} {% include modules/one-column.liquid, id: "suggested-retirement-timetable" content: content %}