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

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.

@codecov
Copy link

codecov bot commented Sep 30, 2018

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #2293      +/-   ##
==========================================
- Coverage   66.75%   66.67%   -0.09%     
==========================================
  Files         208      208              
  Lines       16971    16971              
==========================================
- Hits        11329    11315      -14     
- Misses       4275     4283       +8     
- Partials     1367     1373       +6
Flag Coverage Δ
#criv1alpha1test 32.42% <ø> (-0.18%) ⬇️
#criv1alpha2test 36% <ø> (-0.18%) ⬇️
#integrationtest 39.45% <ø> (-0.04%) ⬇️
#nodee2etest 33.35% <ø> (+0.07%) ⬆️
#unittest 23.75% <ø> (ø) ⬆️
Impacted Files Coverage Δ
apis/server/utils.go 61.9% <0%> (-4.77%) ⬇️
ctrd/watch.go 75.75% <0%> (-4.55%) ⬇️
daemon/containerio/cri_log_file.go 84.31% <0%> (-3.93%) ⬇️
cri/v1alpha2/cri_wrapper.go 61.2% <0%> (-1.2%) ⬇️
cri/v1alpha1/cri.go 61.27% <0%> (-0.33%) ⬇️
daemon/mgr/container.go 57.23% <0%> (-0.21%) ⬇️
cri/v1alpha2/cri.go 66.17% <0%> (ø) ⬆️

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission, we really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@allencloud
Copy link
Collaborator

LGTM

@pouchrobot pouchrobot added the LGTM one maintainer or community participant agrees to merge the pull reuqest. label Sep 30, 2018
@allencloud allencloud merged commit 93a07e4 into AliyunContainerService:master Sep 30, 2018
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