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: remove recommended fallback if there is a config #869

Closed

Conversation

tatomyr
Copy link
Contributor

@tatomyr tatomyr commented Sep 14, 2022

What/Why/How?

Currently we provide the default fallback with the recommended ruleset if there's no extends explicitly set up in a Redocly config file or there's no config file at all.

We put a deprecation message some time ago, and now it's the highest time to finally change the approach: to extend with the default ruleset ONLY when there's no config provided.

Also it would be great to remove the deprecated suggestions (like apiDefinitions &c.).

  • change default fallback behaviour
  • check configs for braking changes
  • remove deprecated suggestions

Reference

Testing

Screenshots (optional)

Check yourself

  • Code is linted
  • Tested with redoc/reference-docs/workflows
  • All new/updated code is covered with tests

Security

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

@tatomyr tatomyr self-assigned this Sep 14, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Sep 14, 2022

Coverage report

St.
Category Percentage Covered / Total
🟡 Statements 73.41% 3285/4475
🟡 Branches 64.99% 1832/2819
🟡 Functions 66.39% 555/836
🟡 Lines 73.32% 3051/4161
Show files with reduced coverage 🔻
St.
File Statements Branches Functions Lines
🟢
... / config-resolvers.ts
86.21%
75.1% (-1.48% 🔻)
100% 86.33%

Test suite run success

509 tests passing in 84 suites.

Report generated by 🧪jest coverage report action from 0b4b97c

@tatomyr tatomyr force-pushed the chore/remove-recommended-fallback-for-existing-config branch from 8ed0b09 to f1214d5 Compare September 14, 2022 13:24
@tatomyr tatomyr force-pushed the chore/remove-recommended-fallback-for-existing-config branch from a486e6d to 100d86c Compare October 3, 2022 14:47
@tatomyr
Copy link
Contributor Author

tatomyr commented Nov 4, 2022

Closing this in favor of #923

@tatomyr tatomyr closed this Nov 4, 2022
@tatomyr tatomyr deleted the chore/remove-recommended-fallback-for-existing-config branch May 31, 2023 16:42
@tatomyr tatomyr restored the chore/remove-recommended-fallback-for-existing-config branch May 31, 2023 16:42
@tatomyr tatomyr deleted the chore/remove-recommended-fallback-for-existing-config branch May 31, 2023 16:43
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