mirror of https://github.com/mozilla/gecko-dev.git synced 2024-11-24 05:11:16 +00:00

History

Julian Descottes f04f586b94 Bug 1780332 - [devtools] Update MDN compat data (2022 July 18th week) r=Honza Differential Revision: https://phabricator.services.mozilla.com/D152249		2022-07-20 08:54:06 +00:00
..
bin	Bug 1777924 - [devtools] Use legacy wrapper in update_remote_settings_records.mjs for forward compatibility with Node 16+ r=nchevobbe	2022-07-04 09:43:11 +00:00
dataset	Bug 1780332 - [devtools] Update MDN compat data (2022 July 18th week) r=Honza	2022-07-20 08:54:06 +00:00
moz.build
package.json	Bug 1754946 - [devtools] Add Node script to populate Remote Settings devtools-compatibility-browsers collection. r=jdescottes.	2022-02-22 08:59:11 +00:00
README.md	Bug 1756620 - [devtools] Remove devtools/shared/compatibility/dataset/browsers.json. r=jdescottes.	2022-03-01 15:20:23 +00:00

README.md

Compatibility Dataset

How to update the MDN compatibility data

The Compatibility panel detects issues by comparing against official MDN compatibility data. It uses a local snapshot of the dataset. This dataset needs to be manually synchronized periodically to devtools/shared/compatibility/dataset (ideally with every Firefox release).

The subsets from the dataset required by the Compatibility panel are:

browsers: https://github.com/mdn/browser-compat-data/tree/master/browsers
css.properties: https://github.com/mdn/browser-compat-data/tree/master/css.

In order to download up-to-date data, you need to run the following commands:

cd devtools/shared/compatibility
yarn install --no-lockfile and select the latest package version for the @mdn/browser-compat-data package
yarn update

This should save the css-properties.json JSON file directly in devtools/shared/compatibility/dataset/.

For the browsers data, we need to update the RemoteSettings collection. While connected to the Mozilla Corporate VPN (See https://mana.mozilla.org/wiki/display/SD/VPN), log into https://settings-writer.stage.mozaws.net/v1/admin/#/buckets/main/collections/devtools-compatibility-browsers/records (Using OpenID Connect (LDAP)). Then copy the authentication header using the icon in the top toolbar. You can then run SERVER=stage AUTH='XXX' yarn update-rs-records, replacing XXX with the value of the authentication header.

The logs should indicate if the collection was updated, and if so, provide a short summary of the modifications. If the collection was updated, then run Firefox, and use the RemoteSettings DevTools WebExtension to use the Stage (preview) environment. Then open the compatibility panel and make sure that the updated browsers do appear in the Settings panel.

If everything looks right, you can run the same command, on the prod server this time: SERVER=prod AUTH='XXX' yarn update-rs-records

Check that all tests still pass. It is possible that changes in the structure or contents of the latest dataset will cause tests to fail. If that is the case, fix the tests. Do not manually change the contents or structure of the local dataset because any changes will be overwritten by the next update from the official dataset.