Add more comments to the Config structs #1630
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dgageot
requested review from
balopat,
nkubala,
priyawadhwa and
r2d4
as code owners
Codecov Report
@@ Coverage Diff @@
## master #1630 +/- ##
======================================
Coverage 46.9% 46.9%
======================================
Files 119 119
Lines 5134 5134
======================================
Hits 2408 2408
Misses 2478 2478
Partials 248 248Continue to review full report at Codecov.
|
Codecov Report
@@ Coverage Diff @@
## master #1630 +/- ##
======================================
Coverage 46.9% 46.9%
======================================
Files 119 119
Lines 5134 5134
======================================
Hits 2408 2408
Misses 2478 2478
Partials 248 248Continue to review full report at Codecov.
|
jonjohnsonjr
reviewed
Feb 8, 2019
pkg/skaffold/schema/latest/config.go
Outdated
| @@ -44,17 +54,44 @@ func (c *SkaffoldPipeline) GetVersion() string { | |||
|
|
|||
| // BuildConfig contains all the configuration for the build steps | |||
| type BuildConfig struct { | |||
| // Artifacts lists the images you're going to be building | |||
| // you can include as many as you want here. | |||
There was a problem hiding this comment.
missing a comma or semicolon or new sentence here
pkg/skaffold/schema/latest/config.go
Outdated
| GoogleCloudBuild *GoogleCloudBuild `yaml:"googleCloudBuild,omitempty" yamltags:"oneOf=build"` | ||
| KanikoBuild *KanikoBuild `yaml:"kaniko,omitempty" yamltags:"oneOf=build"` | ||
|
|
||
| // KanikoBuild describes how to do a on-cluster build using |
pkg/skaffold/schema/latest/config.go
Outdated
| // GoogleCloudBuild describes how to do a remote build on | ||
| // [Google Cloud Build](https://cloud.google.com/cloud-build/docs/). | ||
| // Docker and Jib artifacts can be built on Cloud Build. The `projectId` needs | ||
| // to be provided and the currently logged user should be given permissions to trigger |
pkg/skaffold/schema/latest/config.go
Outdated
| // Defaults to `localDir`. | ||
| BuildContext *KanikoBuildContext `yaml:"buildContext,omitempty"` | ||
|
|
||
| // Cache |
| Cache *KanikoCache `yaml:"cache,omitempty"` | ||
|
|
||
| // AdditionalFlags | ||
| AdditionalFlags []string `yaml:"flags,omitempty"` |
pkg/skaffold/schema/latest/config.go
Outdated
| Version string `yaml:"version,omitempty"` | ||
|
|
||
| // SetValues a list of key-value pairs. | ||
| // If present, Skaffold will sent `--set` flag to Helm CLI and append all pairs after the flag. |
pkg/skaffold/schema/latest/config.go
Outdated
| // Defaults to `false`. | ||
| RecreatePods bool `yaml:"recreatePods,omitempty"` | ||
|
|
||
| // SkipBuildDependencies |
| } | ||
|
|
||
| // JibMavenArtifact builds containers using the Jib plugin for Maven. |
There was a problem hiding this comment.
These are different style than BazelArtifact and DockerArtifact
Signed-off-by: David Gageot <david@gageot.net>
dgageot
force-pushed
the
more-comments
branch
from
703ed78
to
f02d70c
Compare
|
Thanks for the help @jonjohnsonjr! |
priyawadhwa
approved these changes
Feb 11, 2019
balopat
approved these changes
Feb 11, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: David Gageot david@gageot.net