Skip to content

feat(cli): generate Superset CLI docs#24213

Closed
sebastianliebscher wants to merge 3 commits intoapache:masterfrom
sebastianliebscher:feat_gen_cli_docs
Closed

feat(cli): generate Superset CLI docs#24213
sebastianliebscher wants to merge 3 commits intoapache:masterfrom
sebastianliebscher:feat_gen_cli_docs

Conversation

@sebastianliebscher
Copy link
Contributor

@sebastianliebscher sebastianliebscher commented May 25, 2023

SUMMARY

This PR introduces the CLI command update-cli-docs which generates a cli.mdx into docs.

  • searches for all available CLI commands and sub-commands from Click
  • gathers information like arguments and options as markdown content
  • content will be html-sanitized and saved to the docs directory equivalent to the existing update-api-docs CLI function.

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

  • Introduces new feature or API

@codecov
Copy link

codecov bot commented May 25, 2023

Codecov Report

Merging #24213 (4bd5513) into master (f036adb) will increase coverage by 0.02%.
The diff coverage is 23.80%.

❗ Current head 4bd5513 differs from pull request most recent head 9c9a25e. Consider uploading reports for the commit 9c9a25e to get more accurate results

@@            Coverage Diff             @@
##           master   #24213      +/-   ##
==========================================
+ Coverage   68.24%   68.26%   +0.02%     
==========================================
  Files        1956     1957       +1     
  Lines       75589    75637      +48     
  Branches     8223     8224       +1     
==========================================
+ Hits        51582    51637      +55     
+ Misses      21899    21892       -7     
  Partials     2108     2108              
Flag Coverage Δ
hive 53.30% <6.38%> (-0.07%) ⬇️
mysql 78.82% <6.38%> (?)
postgres 78.90% <6.38%> (-0.09%) ⬇️
presto 53.23% <6.38%> (-0.07%) ⬇️
python 82.72% <6.38%> (+<0.01%) ⬆️
sqlite 77.44% <6.38%> (?)
unit 53.35% <6.38%> (-0.07%) ⬇️

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

Impacted Files Coverage Δ
...set-ui-core/src/ui-overrides/ExtensionsRegistry.ts 100.00% <ø> (ø)
...hart-echarts/src/BigNumber/BigNumberTotal/index.ts 66.66% <ø> (ø)
...arts/src/BigNumber/BigNumberWithTrendline/index.ts 66.66% <ø> (ø)
...t-frontend/plugins/plugin-chart-table/src/index.ts 66.66% <ø> (ø)
superset-frontend/src/SqlLab/actions/sqlLab.js 66.66% <ø> (+0.25%) ⬆️
...d/src/SqlLab/components/SqlEditorLeftBar/index.tsx 62.12% <ø> (+0.92%) ⬆️
superset-frontend/src/SqlLab/fixtures.ts 100.00% <ø> (ø)
...et-frontend/src/SqlLab/reducers/getInitialState.js 90.62% <ø> (ø)
superset-frontend/src/SqlLab/reducers/sqlLab.js 38.46% <ø> (+0.21%) ⬆️
superset-frontend/src/SqlLab/types.ts 57.14% <ø> (ø)
... and 9 more

... and 15 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant