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

refactor: remove "error" reporting level, move reportMessage to logger #7642

Merged
merged 1 commit into from Jun 17, 2022

Conversation

Josh-Cena
Copy link
Collaborator

@Josh-Cena Josh-Cena commented Jun 17, 2022

Breaking Change

  • "error" reporting level is removed in favor of "throw"
  • the reportMessage API (internal but maybe used by some?) has been moved/renamed

Pre-flight checklist

  • I have read the Contributing Guidelines on pull requests.
  • If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
  • If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

Motivation

As discussed in #7615, removing the "error" reporting severity to avoid confusion for the users. I've actually been asked similar questions on Discord...

I took this chance to move reportMessage to logger, to make it appear more uniform, and also to take advantage of the interpolate function.

Test Plan

Test links

Deploy preview: https://deploy-preview-_____--docusaurus-2.netlify.app/

Related issues/PRs

@Josh-Cena Josh-Cena added the pr: breaking change Existing sites may not build successfully in the new version. Description contains more details. label Jun 17, 2022
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Jun 17, 2022
@netlify
Copy link

netlify bot commented Jun 17, 2022

[V2]

Name Link
🔨 Latest commit 71b5054
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/62ac50a48fcc840008c06f98
😎 Deploy Preview https://deploy-preview-7642--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@github-actions
Copy link

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟠 70 🟢 100 🟢 100 🟢 100 🟢 90 Report
/docs/installation 🟠 82 🟢 100 🟢 100 🟢 100 🟢 90 Report

@github-actions
Copy link

Size Change: 0 B

Total Size: 801 kB

ℹ️ View Unchanged
Filename Size
website/.docusaurus/globalData.json 52.6 kB
website/build/assets/css/styles.********.css 106 kB
website/build/assets/js/main.********.js 603 kB
website/build/index.html 38.9 kB

compressed-size-action

@slorber
Copy link
Collaborator

slorber commented Jun 17, 2022

ok 👍 let's give it a try

I'm not sure but I think some plugins might use the reportMessage function, so we'll see if anyone complains and we need to keep retrocompatibility

@Josh-Cena
Copy link
Collaborator Author

I'm not aware of any well-known ones using it.

@slorber slorber merged commit bfba6a8 into main Jun 17, 2022
@slorber slorber deleted the jc/kill-error branch June 17, 2022 12:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA pr: breaking change Existing sites may not build successfully in the new version. Description contains more details.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants