You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@superset.apache.org by "sebastianliebscher (via GitHub)" <gi...@apache.org> on 2023/05/25 15:45:39 UTC
[GitHub] [superset] sebastianliebscher opened a new pull request, #24213: feat(cli): generate Superset CLI docs
sebastianliebscher opened a new pull request, #24213:
URL: https://github.com/apache/superset/pull/24213
### SUMMARY
This PR adds 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
<!--- Required! What steps can be taken to manually verify the changes? -->
### ADDITIONAL INFORMATION
- [x] Introduces new feature or API
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] sebastianliebscher commented on a diff in pull request #24213: feat(cli): generate Superset CLI docs
Posted by "sebastianliebscher (via GitHub)" <gi...@apache.org>.
sebastianliebscher commented on code in PR #24213:
URL: https://github.com/apache/superset/pull/24213#discussion_r1205753153
##########
superset/config.py:
##########
@@ -1583,7 +1583,7 @@ class ExtraRelatedQueryFilters(TypedDict, total=False):
try:
# pylint: disable=import-error,wildcard-import,unused-wildcard-import
import superset_config
- from superset_config import * # type: ignore
+ from superset_config import *
Review Comment:
without this, the mypy pre-commit hook blocks the commit. unsure this is the appropriate approach
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] codecov[bot] commented on pull request #24213: feat(cli): generate Superset CLI docs
Posted by "codecov[bot] (via GitHub)" <gi...@apache.org>.
codecov[bot] commented on PR #24213:
URL: https://github.com/apache/superset/pull/24213#issuecomment-1563143241
## [Codecov](https://app.codecov.io/gh/apache/superset/pull/24213?src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) Report
> Merging [#24213](https://app.codecov.io/gh/apache/superset/pull/24213?src=pr&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) (5bf2848) into [master](https://app.codecov.io/gh/apache/superset/commit/f036adbc4ffca09009a90419afc53ec48e40f15f?el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) (f036adb) will **decrease** coverage by `11.18%`.
> The diff coverage is `21.66%`.
> :exclamation: Current head 5bf2848 differs from pull request most recent head 92e184c. Consider uploading reports for the commit 92e184c to get more accurate results
```diff
@@ Coverage Diff @@
## master #24213 +/- ##
===========================================
- Coverage 68.24% 57.06% -11.18%
===========================================
Files 1956 1957 +1
Lines 75589 75633 +44
Branches 8223 8223
===========================================
- Hits 51582 43159 -8423
- Misses 21899 30367 +8468
+ Partials 2108 2107 -1
```
| Flag | Coverage Δ | |
|---|---|---|
| hive | `?` | |
| postgres | `?` | |
| presto | `53.23% <6.25%> (-0.07%)` | :arrow_down: |
| python | `59.55% <6.25%> (-23.16%)` | :arrow_down: |
| unit | `53.35% <6.25%> (-0.07%)` | :arrow_down: |
Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#carryforward-flags-in-the-pull-request-comment) to find out more.
| [Impacted Files](https://app.codecov.io/gh/apache/superset/pull/24213?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | Coverage Δ | |
|---|---|---|
| [superset-frontend/src/SqlLab/actions/sqlLab.js](https://app.codecov.io/gh/apache/superset/pull/24213?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#diff-c3VwZXJzZXQtZnJvbnRlbmQvc3JjL1NxbExhYi9hY3Rpb25zL3NxbExhYi5qcw==) | `66.66% <ø> (+0.25%)` | :arrow_up: |
| [...d/src/SqlLab/components/SqlEditorLeftBar/index.tsx](https://app.codecov.io/gh/apache/superset/pull/24213?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#diff-c3VwZXJzZXQtZnJvbnRlbmQvc3JjL1NxbExhYi9jb21wb25lbnRzL1NxbEVkaXRvckxlZnRCYXIvaW5kZXgudHN4) | `62.12% <ø> (+0.92%)` | :arrow_up: |
| [superset-frontend/src/SqlLab/fixtures.ts](https://app.codecov.io/gh/apache/superset/pull/24213?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#diff-c3VwZXJzZXQtZnJvbnRlbmQvc3JjL1NxbExhYi9maXh0dXJlcy50cw==) | `100.00% <ø> (ø)` | |
| [...et-frontend/src/SqlLab/reducers/getInitialState.js](https://app.codecov.io/gh/apache/superset/pull/24213?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#diff-c3VwZXJzZXQtZnJvbnRlbmQvc3JjL1NxbExhYi9yZWR1Y2Vycy9nZXRJbml0aWFsU3RhdGUuanM=) | `90.62% <ø> (ø)` | |
| [superset-frontend/src/SqlLab/reducers/sqlLab.js](https://app.codecov.io/gh/apache/superset/pull/24213?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#diff-c3VwZXJzZXQtZnJvbnRlbmQvc3JjL1NxbExhYi9yZWR1Y2Vycy9zcWxMYWIuanM=) | `38.46% <ø> (+0.21%)` | :arrow_up: |
| [superset-frontend/src/SqlLab/types.ts](https://app.codecov.io/gh/apache/superset/pull/24213?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#diff-c3VwZXJzZXQtZnJvbnRlbmQvc3JjL1NxbExhYi90eXBlcy50cw==) | `57.14% <ø> (ø)` | |
| [...perset-frontend/src/hooks/apiResources/queryApi.ts](https://app.codecov.io/gh/apache/superset/pull/24213?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#diff-c3VwZXJzZXQtZnJvbnRlbmQvc3JjL2hvb2tzL2FwaVJlc291cmNlcy9xdWVyeUFwaS50cw==) | `100.00% <ø> (ø)` | |
| [superset/cli/main.py](https://app.codecov.io/gh/apache/superset/pull/24213?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#diff-c3VwZXJzZXQvY2xpL21haW4ucHk=) | `0.00% <0.00%> (ø)` | |
| [superset/config.py](https://app.codecov.io/gh/apache/superset/pull/24213?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#diff-c3VwZXJzZXQvY29uZmlnLnB5) | `91.42% <50.00%> (-0.55%)` | :arrow_down: |
| [...d/src/SqlLab/components/AceEditorWrapper/index.tsx](https://app.codecov.io/gh/apache/superset/pull/24213?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#diff-c3VwZXJzZXQtZnJvbnRlbmQvc3JjL1NxbExhYi9jb21wb25lbnRzL0FjZUVkaXRvcldyYXBwZXIvaW5kZXgudHN4) | `65.90% <66.66%> (-1.54%)` | :arrow_down: |
| ... and [3 more](https://app.codecov.io/gh/apache/superset/pull/24213?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | |
... and [307 files with indirect coverage changes](https://app.codecov.io/gh/apache/superset/pull/24213/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)
:mega: We’re building smart automated test selection to slash your CI/CD build times. [Learn more](https://about.codecov.io/iterative-testing/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] sebastianliebscher closed pull request #24213: feat(cli): generate Superset CLI docs
Posted by "sebastianliebscher (via GitHub)" <gi...@apache.org>.
sebastianliebscher closed pull request #24213: feat(cli): generate Superset CLI docs
URL: https://github.com/apache/superset/pull/24213
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org