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 #2108

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 Aug 17, 2018
@allencloud allencloud merged commit 5c5cb93 into AliyunContainerService:master Aug 17, 2018
@codecov-io
Copy link

Codecov Report

Merging #2108 into master will decrease coverage by 0.08%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #2108      +/-   ##
==========================================
- Coverage   65.11%   65.03%   -0.09%     
==========================================
  Files         208      208              
  Lines       16409    16409              
==========================================
- Hits        10685    10671      -14     
- Misses       4393     4400       +7     
- Partials     1331     1338       +7
Flag Coverage Δ
#criv1alpha1test 33.14% <ø> (-0.08%) ⬇️
#criv1alpha2test 33.78% <ø> (-0.11%) ⬇️
#integrationtest 39.83% <ø> (-0.03%) ⬇️
#unittest 23.87% <ø> (ø) ⬆️
Impacted Files Coverage Δ
apis/server/utils.go 61.9% <0%> (-4.77%) ⬇️
ctrd/watch.go 72.72% <0%> (-3.04%) ⬇️
ctrd/container.go 42.06% <0%> (-1.45%) ⬇️
daemon/mgr/container.go 55.49% <0%> (-0.61%) ⬇️
cri/v1alpha1/cri.go 63.66% <0%> (-0.18%) ⬇️
cri/v1alpha2/cri.go 64.51% <0%> (-0.17%) ⬇️
ctrd/image.go 78.94% <0%> (+1.75%) ⬆️

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