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

docs: update lock + general cleanup #19350

Merged
merged 5 commits into from
Mar 24, 2022

Conversation

villebro
Copy link
Member

SUMMARY

Many small updates to the docs package:

  • Remove redundant package-lock.json as we're using yarn in CI (better to just have one workflow)
  • Add missing packages to docs lock file that were introduced in feat: Implements Docusearch into docusaurus docs #19289
  • Add missing peer dependencies that were emitting warnings
  • Bump Docusaurus from ^2.0.0-beta.15 to ^2.0.0-beta.17
  • Fix the alert TODO and bump antd (we may consider removing antd, as it's only used for this one component)
  • Update OpenAPI spec and fix the script that generates it (this should be automated in a follow-up PR)

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

Previously lots of warnings were emitted:

$ yarn install
yarn install v1.22.17
warning package-lock.json found. Your project contains lock files generated by tools other than Yarn. It is advised not to mix package managers in order to avoid resolution inconsistencies caused by unsynchronized lock files. To clear this warning, remove package-lock.json.
[1/4] 🔍  Resolving packages...
[2/4] 🚚  Fetching packages...
[3/4] 🔗  Linking dependencies...
warning " > @docsearch/[email protected]" has unmet peer dependency "@types/react@>= 16.8.0 < 18.0.0".
warning "@docsearch/react > @algolia/[email protected]" has unmet peer dependency "@algolia/client-search@^4.9.1".
warning " > [email protected]" has unmet peer dependency "webpack@^4.0.0 || ^5.0.0".
warning " > [email protected]" has unmet peer dependency "webpack@^4.0.0 || ^5.0.0".
warning "@docusaurus/core > @docusaurus/utils > @mdx-js/[email protected]" has incorrect peer dependency "react@^16.13.1".
warning "@docusaurus/preset-classic > @docusaurus/theme-search-algolia > @docsearch/[email protected]" has unmet peer dependency "@types/react@>= 16.8.0 < 18.0.0".
warning "@docusaurus/preset-classic > @docusaurus/theme-search-algolia > @docsearch/react > @algolia/[email protected]" has unmet peer dependency "@algolia/client-search@^4.9.1".
warning " > [email protected]" has incorrect peer dependency "react@^16.11.0".
warning "theme-ui > @theme-ui/[email protected]" has incorrect peer dependency "react@^16.11.0".
warning "theme-ui > @theme-ui/[email protected]" has incorrect peer dependency "react@^16.8.0".
warning "theme-ui > @theme-ui/[email protected]" has incorrect peer dependency "react@^16.11.0".
warning "theme-ui > @theme-ui/[email protected]" has incorrect peer dependency "react@^16.11.0".
warning "theme-ui > @theme-ui/[email protected]" has incorrect peer dependency "react@^16.11.0".
success Saved lockfile.
✨  Done in 160.16s.
$

After:

$ yarn install
yarn install v1.22.17
[1/4] 🔍  Resolving packages...
[2/4] 🚚  Fetching packages...
[3/4] 🔗  Linking dependencies...
[4/4] 🔨  Building fresh packages...
✨  Done in 334.77s.
$

TESTING INSTRUCTIONS

Make sure that docs work like before

ADDITIONAL INFORMATION

  • Has associated issue:
  • Required feature flags:
  • Changes UI
  • Includes DB Migration (follow approval process in SIP-59)
    • Migration is atomic, supports rollback & is backwards-compatible
    • Confirm DB migration upgrade and downgrade tested
    • Runtime estimates and downtime expectations provided
  • Introduces new feature or API
  • Removes existing feature or API

$ yarn
$ yarn install
Copy link
Member Author

Choose a reason for hiding this comment

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

while this doesn't change behaviour, I feel being more explicit is better

@villebro villebro changed the title Villebro/docs lock docs: update lock + general cleanup Mar 24, 2022
@codecov
Copy link

codecov bot commented Mar 24, 2022

Codecov Report

Merging #19350 (e726095) into master (202e34a) will decrease coverage by 0.15%.
The diff coverage is 84.21%.

❗ Current head e726095 differs from pull request most recent head a86bcd3. Consider uploading reports for the commit a86bcd3 to get more accurate results

@@            Coverage Diff             @@
##           master   #19350      +/-   ##
==========================================
- Coverage   66.63%   66.48%   -0.16%     
==========================================
  Files        1675     1675              
  Lines       64660    64654       -6     
  Branches     6503     6503              
==========================================
- Hits        43086    42985     -101     
- Misses      19888    19983      +95     
  Partials     1686     1686              
Flag Coverage Δ
hive ?
mysql 81.65% <84.21%> (?)
postgres 81.70% <84.21%> (-0.01%) ⬇️
presto ?
python 81.78% <84.21%> (-0.30%) ⬇️
sqlite 81.46% <84.21%> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
...s/superset-ui-core/src/query/api/v1/handleError.ts 100.00% <ø> (ø)
superset/cli/update.py 0.00% <0.00%> (ø)
superset/cli/importexport.py 80.00% <50.00%> (ø)
superset/config.py 91.69% <100.00%> (-0.03%) ⬇️
superset/tasks/async_queries.py 91.02% <100.00%> (ø)
superset/utils/async_query_manager.py 81.18% <100.00%> (-1.06%) ⬇️
superset/views/core.py 75.87% <100.00%> (+0.43%) ⬆️
superset/db_engines/hive.py 0.00% <0.00%> (-85.19%) ⬇️
superset/db_engine_specs/hive.py 70.00% <0.00%> (-15.77%) ⬇️
superset/db_engine_specs/presto.py 83.68% <0.00%> (-5.44%) ⬇️
... and 7 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 202e34a...a86bcd3. Read the comment docs.

@zhaoyongjie zhaoyongjie self-requested a review March 24, 2022 13:13
Copy link
Member

@zhaoyongjie zhaoyongjie left a comment

Choose a reason for hiding this comment

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

Test this PR in the local environment. Document build works fine. LGTM!

@villebro villebro merged commit 3313530 into apache:master Mar 24, 2022
@villebro villebro deleted the villebro/docs-lock branch March 24, 2022 13:43
villebro added a commit that referenced this pull request Apr 3, 2022
* docs: update lock file

* remove redundant npm lock file

* add missing peer deps

* fix TODO and bump antd

* fix API spec script

(cherry picked from commit 3313530)
philipher29 pushed a commit to ValtechMobility/superset that referenced this pull request Jun 9, 2022
* docs: update lock file

* remove redundant npm lock file

* add missing peer deps

* fix TODO and bump antd

* fix API spec script
@mistercrunch mistercrunch added 🍒 1.5.0 🍒 1.5.1 🍒 1.5.2 🍒 1.5.3 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 2.0.0 labels Mar 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels lts-v1 preset-io size/XXL 🍒 1.5.0 🍒 1.5.1 🍒 1.5.2 🍒 1.5.3 🚢 2.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants