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 docs via code #2195

Merged

Conversation

pouchrobot
Copy link
Collaborator

Signed-off-by: pouchrobot [email protected]

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
First, execute command "make client" to build new pouch cli;
Second, execute command "./pouch gen-doc" to generate new cli docs.

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.

@allencloud
Copy link
Collaborator

LGTM

@pouchrobot pouchrobot added the LGTM one maintainer or community participant agrees to merge the pull reuqest. label Sep 4, 2018
@allencloud allencloud merged commit 14c94cf into AliyunContainerService:master Sep 4, 2018
@codecov-io
Copy link

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #2195      +/-   ##
==========================================
+ Coverage   64.98%   64.99%   +0.01%     
==========================================
  Files         208      208              
  Lines       16732    16732              
==========================================
+ Hits        10873    10875       +2     
  Misses       4509     4509              
+ Partials     1350     1348       -2
Flag Coverage Δ
#criv1alpha1test 32.9% <ø> (+0.17%) ⬆️
#criv1alpha2test 33.63% <ø> (+0.05%) ⬆️
#integrationtest 39.92% <ø> (-0.02%) ⬇️
#unittest 23.95% <ø> (ø) ⬆️
Impacted Files Coverage Δ
ctrd/watch.go 75.75% <0%> (-4.55%) ⬇️
ctrd/image.go 76.75% <0%> (-0.44%) ⬇️
daemon/mgr/container.go 56.98% <0%> (ø) ⬆️
cri/v1alpha2/cri.go 63.78% <0%> (+0.32%) ⬆️
cri/v1alpha1/cri.go 62.73% <0%> (+0.34%) ⬆️
apis/server/utils.go 66.66% <0%> (+4.76%) ⬆️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
areas/docs LGTM one maintainer or community participant agrees to merge the pull reuqest. size/XS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants