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

[kpt deployer] Improve skaffold.yaml docs. #4799

Merged
merged 1 commit into from
Sep 17, 2020

Conversation

yuwenma
Copy link
Contributor

@yuwenma yuwenma commented Sep 17, 2020

Related #3904

Description

  • kpt.Dir is required, adding the explanation on the default config.
  • kpt.applyDir is removed from top-tier config.
  • Rewrote the kpt.Live struct to clarify the config scope and which configs should be considered together.
  • Improve the kpt option docstring for skaffold users.

User facing changes (remove if N/A)

Changed the doc in skaffold.yaml for kpt deployer.

* kpt.Dir is required, adding the explanation on the default config.
* kpt.applyDir is removed from top-tier config.
* Rewrote the kpt.Live struct to clarify the config scope and which configs should be considered together.
* Improve the kpt option docstring for skaffold users.
@yuwenma
Copy link
Contributor Author

yuwenma commented Sep 17, 2020

/cc @nkubala
/assign @MarlonGamez

@codecov
Copy link

codecov bot commented Sep 17, 2020

Codecov Report

Merging #4799 into master will decrease coverage by 2.01%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #4799      +/-   ##
==========================================
- Coverage   73.84%   71.82%   -2.02%     
==========================================
  Files         347      347              
  Lines       13798    11869    -1929     
==========================================
- Hits        10189     8525    -1664     
+ Misses       2973     2725     -248     
+ Partials      636      619      -17     
Impacted Files Coverage Δ
pkg/skaffold/schema/latest/config.go 100.00% <ø> (ø)
pkg/skaffold/deploy/kpt.go 85.88% <100.00%> (-0.96%) ⬇️
pkg/skaffold/trigger/workdir.go 20.00% <0.00%> (-13.34%) ⬇️
pkg/skaffold/initializer/analyze/directory.go 50.00% <0.00%> (-10.00%) ⬇️
pkg/diag/validator/resource.go 50.00% <0.00%> (-8.83%) ⬇️
pkg/skaffold/logfile/logfile.go 71.42% <0.00%> (-8.58%) ⬇️
pkg/skaffold/runner/debugging.go 66.66% <0.00%> (-8.34%) ⬇️
pkg/skaffold/deploy/resource/status.go 77.77% <0.00%> (-7.94%) ⬇️
pkg/skaffold/runner/portforwarder.go 22.22% <0.00%> (-7.78%) ⬇️
pkg/skaffold/runner/render.go 12.50% <0.00%> (-7.50%) ⬇️
... and 339 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 2b50012...64f3033. Read the comment docs.

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.

LGTM!

@MarlonGamez MarlonGamez merged commit 9fb4e81 into GoogleContainerTools:master Sep 17, 2020
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.

3 participants