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

chore: update error messages #1571

Merged
merged 5 commits into from
May 28, 2024
Merged

chore: update error messages #1571

merged 5 commits into from
May 28, 2024

Conversation

tatomyr
Copy link
Contributor

@tatomyr tatomyr commented May 28, 2024

What/Why/How?

Updated a couple of error messages to make the format more consistent.
We don't need the extra lines as the exitWithError function already adds them.

Also corrected the wrong url: https://github.com/Redocly/redocly-cli/pull/1571/files#diff-2fb448d11702324cc59d657d5945d59cd325540eb87b71f2e66a5bc01ada834cR730

Reference

Testing

Screenshots (optional)

Check yourself

  • Code changed? - Tested with redoc/reference-docs/workflows (internal)
  • All new/updated code is covered with tests
  • New package installed? - Tested in different environments (browser/node)

Security

  • Security impact of change has been considered
  • Code follows company security practices and guidelines

@tatomyr tatomyr requested a review from a team as a code owner May 28, 2024 09:29
Copy link

changeset-bot bot commented May 28, 2024

🦋 Changeset detected

Latest commit: b2761fe

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages
Name Type
@redocly/cli Patch
@redocly/openapi-core Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@tatomyr tatomyr self-assigned this May 28, 2024
Copy link
Contributor

github-actions bot commented May 28, 2024

Command Mean [ms] Min [ms] Max [ms] Relative
redocly lint packages/core/src/benchmark/benches/rebilly.yaml 987.0 ± 22.0 965.7 1028.0 1.00
redocly-next lint packages/core/src/benchmark/benches/rebilly.yaml 1000.9 ± 17.0 977.0 1029.8 1.01 ± 0.03

Copy link
Contributor

github-actions bot commented May 28, 2024

Coverage report

St.
Category Percentage Covered / Total
🟡 Statements 77.25% 4481/5801
🟡 Branches 67.48% 2467/3656
🟡 Functions 70.86% 744/1050
🟡 Lines 77.43% 4214/5442

Test suite run success

735 tests passing in 102 suites.

Report generated by 🧪jest coverage report action from b2761fe

Copy link
Collaborator

@lornajane lornajane left a comment

Choose a reason for hiding this comment

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

Minor thing, also I suggest we add a changelog here despite it being a chore. It wouldn't be too surprising if people were matching error messages in their own code, so we should probably let them know that they might see a change.

packages/cli/src/commands/join.ts Outdated Show resolved Hide resolved
Co-authored-by: Lorna Jane Mitchell <github@lornajane.net>
@tatomyr tatomyr requested a review from a team as a code owner May 28, 2024 11:50
@tatomyr tatomyr requested a review from lornajane May 28, 2024 12:00
@tatomyr tatomyr merged commit a53bb35 into main May 28, 2024
31 checks passed
@tatomyr tatomyr deleted the chore/update-error-messages branch May 28, 2024 15:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants