Skip to content

Add a linter/fix script for mdn_urls #23431

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.

Sign up for GitHub

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

Jump to bottom
Merged
queengooborg merged 8 commits into from
Jun 26, 2024
Merged

Add a linter/fix script for mdn_urls #23431

queengooborg merged 8 commits into from
Jun 26, 2024

Conversation

@Elchi3
Copy link
Member

@Elchi3 Elchi3 commented Jun 18, 2024 •
edited
Loading

This PR uses the mdn/content inventory and mdn/content's _redirect.txt file to update mdn_urls automatically.

  • It removes 404 mdn_urls
  • It replace redirect urls with the new url per the redirect file
  • It replaces wrong casing
  • It adds new mdn_urls when pages have been found existing at conventional places.

It works with the https://www.npmjs.com/package/@ddbeck/mdn-content-inventory package. Whenever dependabot updates this dependency it might be that this lint fails, maintainers can then look at the failures and run npm run fix to update mdn_urls automatically and, if needed, make manual changes.

The initial update to mdn_urls (that will make this PR pass CI) is #23481 and so this PR is blocked by having #23481 merged.

@github-actions github-actions bot added infra Infrastructure issues (npm, GitHub Actions, releases) of this project linter Issues or pull requests regarding the tests / linter of the JSON files. dependencies Pull requests that update a dependency package or file. labels Jun 18, 2024
ddbeck
ddbeck reviewed Jun 18, 2024
View reviewed changes
ddbeck
ddbeck reviewed Jun 19, 2024
View reviewed changes
@Elchi3 Elchi3 mentioned this pull request Jun 20, 2024
Merged
@Elchi3 Elchi3 mentioned this pull request Jun 21, 2024
Merged
@Elchi3 Elchi3 marked this pull request as ready for review June 21, 2024 08:06
@Elchi3 Elchi3 requested a review from queengooborg June 22, 2024 11:22
@Josh-Cena
Copy link
Member

Josh-Cena commented Jun 23, 2024

See #23481 (review)

@Elchi3
Copy link
Member Author

Elchi3 commented Jun 24, 2024

@Josh-Cena

FWIW this seems slightly inconvenient in the context of fixing MDN gaps, since every new doc now also requires a BCD update, but I think it's generally an improvement, and it'll probably take us a long while to fix all MDN gaps...

Thanks for your feedback. What you describe is already happening and leads to lots of PRs and review work which IMO can be automated. My intent with this PR is to actually prevent PRs like #23499 (and see tons of them at: https://github.com/mdn/browser-compat-data/pulls?q=is%3Apr+mdn_url+is%3Aclosed). The idea is that we add mdn_urls automatically whenever dependabot updates the mdn-content-inventory package (which will release frequently).

@Elchi3 Elchi3 mentioned this pull request Jun 25, 2024
Merged
@github-actions github-actions bot added data:webext Compat data for Browser Extensions. https://developer.mozilla.org/Add-ons/WebExtensions data:api Compat data for Web APIs. https://developer.mozilla.org/docs/Web/API labels Jun 26, 2024
@queengooborg queengooborg merged commit 75f2c64 into mdn:main Jun 26, 2024
@Elchi3 Elchi3 deleted the lint-fix-mdn-urls branch June 26, 2024 08:23
@Elchi3 Elchi3 mentioned this pull request Jun 26, 2024
Closed
@ddbeck ddbeck mentioned this pull request Jun 28, 2024
Closed
@skyclouds2001 skyclouds2001 mentioned this pull request Jul 1, 2024
Closed
@queengooborg queengooborg mentioned this pull request Jul 2, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ddbeck ddbeck ddbeck left review comments

@queengooborg queengooborg queengooborg approved these changes

Assignees

No one assigned

Labels

data:api Compat data for Web APIs. https://developer.mozilla.org/docs/Web/API data:webext Compat data for Browser Extensions. https://developer.mozilla.org/Add-ons/WebExtensions dependencies Pull requests that update a dependency package or file. infra Infrastructure issues (npm, GitHub Actions, releases) of this project linter Issues or pull requests regarding the tests / linter of the JSON files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@Elchi3 @Josh-Cena @ddbeck @queengooborg