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

Documentation - CI/CD Tutorial End to End with Skaffold #4909

Merged
merged 6 commits into from
Nov 16, 2020

Conversation

tvvignesh
Copy link
Contributor

@tvvignesh tvvignesh commented Oct 14, 2020

Fixes: #346

Description
This PR add documentation for CI/CD end to end with skaffold

Hi. Have added all the contents for the tutorial here. Do let me know if you need anything else.

Regards,
Vignesh T.V.
@tvvignesh tvvignesh requested a review from a team as a code owner October 14, 2020 00:33
@tvvignesh tvvignesh requested a review from tejal29 October 14, 2020 00:33
@google-cla
Copy link

google-cla bot commented Oct 14, 2020

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.


What to do if you already signed the CLA

Individual signers
Corporate signers

ℹ️ Googlers: Go here for more info.

@tvvignesh
Copy link
Contributor Author

@googlebot I signed it!

@google-cla google-cla bot added cla: yes and removed cla: no labels Oct 14, 2020
@codecov
Copy link

codecov bot commented Oct 14, 2020

Codecov Report

Merging #4909 (0626bbe) into master (c6260e8) will increase coverage by 0.22%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #4909      +/-   ##
==========================================
+ Coverage   71.96%   72.18%   +0.22%     
==========================================
  Files         357      365       +8     
  Lines       12327    12842     +515     
==========================================
+ Hits         8871     9270     +399     
- Misses       2799     2881      +82     
- Partials      657      691      +34     
Impacted Files Coverage Δ
pkg/skaffold/schema/v2beta8/upgrade.go 88.88% <0.00%> (-11.12%) ⬇️
pkg/skaffold/errors/err_map.go 90.56% <0.00%> (-9.44%) ⬇️
pkg/skaffold/build/gcb/kaniko.go 73.33% <0.00%> (-9.02%) ⬇️
pkg/skaffold/deploy/kpt/kpt.go 75.17% <0.00%> (-8.57%) ⬇️
pkg/skaffold/build/gcb/buildpacks.go 92.00% <0.00%> (-8.00%) ⬇️
pkg/skaffold/initializer/build/resolve.go 79.16% <0.00%> (-5.45%) ⬇️
pkg/skaffold/runner/load_images.go 94.73% <0.00%> (-5.27%) ⬇️
...g/skaffold/kubernetes/portforward/entry_manager.go 92.00% <0.00%> (-3.84%) ⬇️
pkg/skaffold/build/local/prune.go 70.11% <0.00%> (-3.38%) ⬇️
pkg/skaffold/docker/parse.go 84.06% <0.00%> (-3.22%) ⬇️
... and 68 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c6260e8...0626bbe. Read the comment docs.

@gsquared94
Copy link
Contributor

Please take a look @viglesiasce

Copy link
Contributor

@MarlonGamez MarlonGamez left a comment

Choose a reason for hiding this comment

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

Thanks for submitting this PR @tvvignesh! I've taken a first pass at it, mostly just commenting on nits related to readability and language, not so much on content. Let me know what you think of my suggestions :)

tvvignesh and others added 2 commits October 20, 2020 10:12
Applied the suggestions as given to the doc.

Co-authored-by: Marlon Gamez <marlongamez@google.com>
@tvvignesh
Copy link
Contributor Author

@MarlonGamez Thanks a lot for your suggestions. Have made all the necessary changes. Let me know if there is anything else to be done.

@tejal29
Copy link
Contributor

tejal29 commented Oct 20, 2020

Thanks @tvvignesh And @MarlonGamez for taking this forward!

@MarlonGamez
Copy link
Contributor

@tvvignesh thanks a bunch for making the changes :) One thing I would say is that I think the step labels should be h2s (like step 6 was previously), just to make a bit more clear where each step starts

@tvvignesh
Copy link
Contributor Author

I will spend sometime next week on this and try to do a rewrite taking into account @briandealwis 's suggestions. Please leave all your suggestions here. Thanks.

@MarlonGamez
Copy link
Contributor

hey @tvvignesh, have you had the chance to work on this a bit? No rush, just curious :) thanks again for working on this!

@tvvignesh
Copy link
Contributor Author

hey @tvvignesh, have you had the chance to work on this a bit? No rush, just curious :) thanks again for working on this!

@briandealwis @MarlonGamez Hi. Pushed the changes. Have tried to address all the feedback as given above.

Hope this is okay.

Copy link
Contributor

@nkubala nkubala left a comment

Choose a reason for hiding this comment

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

in interest of not blocking this indefinitely, let's merge it for now and we can make edits later as we need them.

this would be a great addition to #5031 if it ever gets created.

thanks for all your work on this one @tvvignesh!

@nkubala nkubala added the kokoro:run runs the kokoro jobs on a PR label Nov 16, 2020
@kokoro-team kokoro-team removed the kokoro:run runs the kokoro jobs on a PR label Nov 16, 2020
@nkubala nkubala merged commit 716a9a3 into GoogleContainerTools:master Nov 16, 2020
@tvvignesh tvvignesh deleted the patch-1 branch November 18, 2020 20:07
@tvvignesh
Copy link
Contributor Author

@nkubala Forgot to inform this. I did not update https://github.com/GoogleContainerTools/skaffold/blob/master/docs/content/en/docs/tutorials/_index.md linking to this tutorial MD file deliberately since I wanted to leave it to you to decide where to link this in the website if needed.

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.

documentation: Add CI/CD example
7 participants