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

Bug-1930334 to implement background.preferred_environment #37876

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

rebloor
Copy link
Contributor

@rebloor rebloor commented Jan 30, 2025

Description

Add release note and documentation for the introduction of preferred_environment to the background manifest key as implemented by Bug 1930334 Implement background.preferred_environment.

Related issues and pull requests

Corresponding changes to the browser compatibility data in TBC

@rebloor rebloor added the Content:WebExt WebExtensions docs label Jan 30, 2025
@rebloor rebloor requested a review from dotproto January 30, 2025 02:06
@rebloor rebloor self-assigned this Jan 30, 2025
@rebloor rebloor requested review from a team as code owners January 30, 2025 02:06
@rebloor rebloor requested review from bsmth and removed request for a team January 30, 2025 02:06
@github-actions github-actions bot added Content:Firefox Content in the Mozilla/Firefox subtree size/s [PR only] 6-50 LoC changed labels Jan 30, 2025
@github-actions github-actions bot added the merge conflicts 🚧 [PR only] label Jan 30, 2025
Copy link
Contributor

This pull request has merge conflicts that must be resolved before it can be merged.

@github-actions github-actions bot removed the merge conflicts 🚧 [PR only] label Jan 31, 2025
Copy link
Contributor

github-actions bot commented Jan 31, 2025

Preview URLs

Flaws (2)

Note! 1 document with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Mozilla/Firefox/Releases/136
Title: Firefox 136 for developers
Flaw count: 2

  • macros:
    • Macro produces link /en-US/docs/Mozilla/Add-ons/WebExtensions/API/contextMenus/update which is a redirect
    • Macro produces link /en-US/docs/Mozilla/Add-ons/WebExtensions/API/contextMenus/remove which is a redirect
External URLs (1)

URL: /en-US/docs/Mozilla/Firefox/Releases/136
Title: Firefox 136 for developers

(comment last updated: 2025-01-31 16:10:19)

Copy link
Contributor

@carlosjeurissen carlosjeurissen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for updating the docs! Made a few changes to clarify this is an array, not a string value.

<tr>
<td><code>preferred_environment</code></td>
<td>
<p>A <code>String</code> value.</p>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<p>A <code>String</code> value.</p>
<p>An <code>Array</code> of <code>String<code>.</p>

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@carlosjeurissen so you could specify ["document", "service_worker"]? Or can you only specify one value in the array?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rebloor yes, multiple values can be specified. Any of the following are valid:
["document", "service_worker"]
["service_worker", "document"]
["service_worker"]
["document"]
And potentially more

The most sensible at this moment however are
["service_worker", "document"] and
["document", "service_worker"]

As you either prefer the "document" or "service_worker" environment.

rebloor and others added 3 commits February 1, 2025 04:31
Co-authored-by: carlosjeurissen <1038267+carlosjeurissen@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:Firefox Content in the Mozilla/Firefox subtree Content:WebExt WebExtensions docs size/s [PR only] 6-50 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants