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: auto generate pouch cli/api/contributors docs via code #2900

Merged

Conversation

pouchrobot
Copy link
Collaborator

Signed-off-by: pouchrobot pouch-dev@alibaba-inc.com

1.Describe what this PR did
This PR is automatically done by AI-based collaborating robot.
Pouchrobot will auto-generate cli/api document via https://github.com/spf13/cobra/tree/master/doc every day.

2.Does this pull request fix one issue?
None

3.Describe how you did it
We use the following user input CLI document generating command in pouchrobot to generate CLI doc:
go build -o /usr/bin/pouch ./cli; pouch gen-doc

For API part, we use a tool swagger2markup to make it.

4.Describe how to verify it
None

5.Special notes for reviews
The cli/api doc must be automatically generated.

Signed-off-by: pouchrobot <pouch-dev@list.alibaba-inc.com>
@codecov
Copy link

codecov bot commented Jun 10, 2019

Codecov Report

Merging #2900 into master will increase coverage by 1.63%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #2900      +/-   ##
==========================================
+ Coverage   67.21%   68.85%   +1.63%     
==========================================
  Files         291      291              
  Lines       18238    18238              
==========================================
+ Hits        12258    12557     +299     
+ Misses       4525     4225     -300     
- Partials     1455     1456       +1
Flag Coverage Δ
#criv1alpha2_test 38.37% <ø> (+0.02%) ⬆️
#integration_test_0 36.19% <ø> (?)
#integration_test_1 35.65% <ø> (+0.02%) ⬆️
#integration_test_2 36.12% <ø> (-0.06%) ⬇️
#integration_test_3 35.7% <ø> (-0.03%) ⬇️
#node_e2e_test 34.22% <ø> (+0.04%) ⬆️
#unittest 28.05% <ø> (ø) ⬆️
Impacted Files Coverage Δ
cri/v1alpha2/cri.go 68.81% <0%> (-0.26%) ⬇️
daemon/mgr/container_validation.go 42.79% <0%> (+0.9%) ⬆️
apis/server/router.go 91.51% <0%> (+1.21%) ⬆️
daemon/mgr/network.go 73.15% <0%> (+1.26%) ⬆️
storage/volume/driver/proxy.go 78.08% <0%> (+1.36%) ⬆️
apis/server/network_bridge.go 66.12% <0%> (+1.61%) ⬆️
storage/volume/core.go 67.63% <0%> (+1.93%) ⬆️
daemon/mgr/container.go 60.35% <0%> (+1.97%) ⬆️
apis/filters/parse.go 83.15% <0%> (+2.1%) ⬆️
ctrd/container.go 53.15% <0%> (+2.29%) ⬆️
... and 24 more

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

Successfully merging this pull request may close these issues.

None yet

2 participants