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

[fix][cli] Dedicated docs tools #20700

Merged
merged 6 commits into from
Jul 4, 2023
Merged

[fix][cli] Dedicated docs tools #20700

merged 6 commits into from
Jul 4, 2023

Conversation

tisonkun
Copy link
Member

@tisonkun tisonkun commented Jul 1, 2023

This closes #18932.

This is a follow-up to #20687. We parse ApiPropertyModel annotations when generate docs in the site repo.

Factor out a module to handle dependency issues. Also payback some debt that inlines CmdDocGen in core modules.

Verified locally.

I'm preparing a counterpart in the site repo now. See apache/pulsar-site#628

Does this pull request potentially affect one of the following parts:

If the box was checked, please highlight the changes

  • Dependencies (add or upgrade a dependency)
  • The public API
  • The schema
  • The default values of configurations
  • The threading model
  • The binary protocol
  • The REST endpoints
  • The admin CLI options
  • The metrics
  • Anything that affects deployment

Documentation

  • doc
  • doc-required
  • doc-not-needed
  • doc-complete

Matching PR in forked repository

PR in forked repository:

Signed-off-by: tison <wander4096@gmail.com>
@tisonkun tisonkun added this to the 3.1.0 milestone Jul 1, 2023
@tisonkun tisonkun self-assigned this Jul 1, 2023
@github-actions github-actions bot added the doc-not-needed Your PR changes do not impact docs label Jul 1, 2023
Signed-off-by: tison <wander4096@gmail.com>
@tisonkun
Copy link
Member Author

tisonkun commented Jul 1, 2023

I'm trying to solve #18932 also and avoid compatibility hack in the site repo. I have an idea and am implementing it.

Signed-off-by: tison <wander4096@gmail.com>
@tisonkun tisonkun marked this pull request as ready for review July 1, 2023 06:59
Signed-off-by: tison <wander4096@gmail.com>
tisonkun added 2 commits July 1, 2023 15:25
Signed-off-by: tison <wander4096@gmail.com>
Signed-off-by: tison <wander4096@gmail.com>
@codecov-commenter
Copy link

Codecov Report

Merging #20700 (1577436) into master (e360379) will increase coverage by 0.41%.
The diff coverage is 58.04%.

Impacted file tree graph

@@             Coverage Diff              @@
##             master   #20700      +/-   ##
============================================
+ Coverage     72.69%   73.11%   +0.41%     
- Complexity    31878    32092     +214     
============================================
  Files          1871     1868       -3     
  Lines        138982   138937      -45     
  Branches      15283    15275       -8     
============================================
+ Hits         101037   101585     +548     
+ Misses        29873    29306     -567     
+ Partials       8072     8046      -26     
Flag Coverage Δ
inttests 24.19% <23.52%> (+0.07%) ⬆️
systests 24.98% <21.00%> (-0.06%) ⬇️
unittests 72.40% <58.04%> (+0.46%) ⬆️

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

Impacted Files Coverage Δ
...in/java/org/apache/pulsar/PulsarBrokerStarter.java 34.13% <ø> (ø)
.../org/apache/pulsar/PulsarClusterMetadataSetup.java 72.51% <ø> (ø)
...g/apache/pulsar/PulsarClusterMetadataTeardown.java 75.75% <ø> (ø)
...org/apache/pulsar/PulsarInitialNamespaceSetup.java 75.00% <ø> (ø)
...ava/org/apache/pulsar/PulsarStandaloneStarter.java 35.38% <ø> (ø)
...sar/PulsarTransactionCoordinatorMetadataSetup.java 63.15% <ø> (ø)
...n/java/org/apache/pulsar/PulsarVersionStarter.java 42.30% <ø> (ø)
...pache/pulsar/broker/tools/GenerateDocsCommand.java 77.27% <ø> (ø)
...a/org/apache/pulsar/broker/web/RequestWrapper.java 54.54% <ø> (ø)
...pache/pulsar/broker/web/ResponseHandlerFilter.java 57.14% <ø> (ø)
... and 20 more

... and 118 files with indirect coverage changes

@tisonkun tisonkun requested a review from Technoboy- July 3, 2023 01:34
Copy link
Contributor

@nicoloboschi nicoloboschi left a comment

Choose a reason for hiding this comment

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

LGTM

@tisonkun
Copy link
Member Author

tisonkun commented Jul 3, 2023

Pending to merge...

@tisonkun tisonkun merged commit db79096 into apache:master Jul 4, 2023
@tisonkun tisonkun deleted the docs-tools branch July 4, 2023 01:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/tool doc-not-needed Your PR changes do not impact docs ready-to-test
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Client] Drop jcommander dependency in Pulsar java client
3 participants