Skip to content

Commit

Permalink
chore: new googleCloudBuildRepoV2 field to configure a remote dependency
Browse files Browse the repository at this point in the history
  • Loading branch information
@renzodavid9
renzodavid9 committed Feb 2, 2024
1 parent db98603 commit 61ed1d2
Show file tree
Hide file tree
Showing 2 changed files with 91 additions and 0 deletions.
64 changes: 64 additions & 0 deletions docs-v2/content/en/schemas/v4beta10.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1319,6 +1319,11 @@
"description": "describes a remote git repository containing the required configs.",
"x-intellij-html-description": "describes a remote git repository containing the required configs."
},
"googleCloudBuildRepoV2": {
"$ref": "#/definitions/GoogleCloudBuildRepoV2Info",
"description": "describes a [Google Cloud Build repository (2nd gen)](https://cloud.google.com/build/docs/repositories#repositories_2nd_gen) that points to a repo with the required configs.",
"x-intellij-html-description": "describes a <a href=\"https://cloud.google.com/build/docs/repositories#repositories_2nd_gen\">Google Cloud Build repository (2nd gen)</a> that points to a repo with the required configs."
},
"googleCloudStorage": {
"$ref": "#/definitions/GoogleCloudStorageInfo",
"description": "describes remote Google Cloud Storage objects containing the required configs.",
Expand All @@ -1335,6 +1340,7 @@
"path",
"git",
"googleCloudStorage",
"googleCloudBuildRepoV2",
"activeProfiles"
],
"additionalProperties": false,
Expand Down Expand Up @@ -2133,6 +2139,64 @@
"description": "*beta* 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 in user should be given permissions to trigger new builds.",
"x-intellij-html-description": "<em>beta</em> describes how to do a remote build on <a href=\"https://cloud.google.com/cloud-build/docs/\">Google Cloud Build</a>. Docker and Jib artifacts can be built on Cloud Build. The <code>projectId</code> needs to be provided and the currently logged in user should be given permissions to trigger new builds."
},
"GoogleCloudBuildRepoV2Info": {
"required": [
"projectID",
"region",
"connection",
"repo"
],
"properties": {
"connection": {
"type": "string",
"description": "name of the GCB repository connection associated with the repo.",
"x-intellij-html-description": "name of the GCB repository connection associated with the repo."
},
"path": {
"type": "string",
"description": "relative path from the repo root to the skaffold configuration file. eg. `getting-started/skaffold.yaml`.",
"x-intellij-html-description": "relative path from the repo root to the skaffold configuration file. eg. <code>getting-started/skaffold.yaml</code>."
},
"projectID": {
"type": "string",
"description": "ID of the GCP project where the repository is configured.",
"x-intellij-html-description": "ID of the GCP project where the repository is configured."
},
"ref": {
"type": "string",
"description": "git ref the repo should be cloned from. e.g. `master` or `main`.",
"x-intellij-html-description": "git ref the repo should be cloned from. e.g. <code>master</code> or <code>main</code>."
},
"region": {
"type": "string",
"description": "GCP region where the repository is configured.",
"x-intellij-html-description": "GCP region where the repository is configured."
},
"repo": {
"type": "string",
"description": "name of repository under the given connection.",
"x-intellij-html-description": "name of repository under the given connection."
},
"sync": {
"type": "boolean",
"description": "when set to `true` will reset the cached repository to the latest commit from remote on every run. To use the cached repository with uncommitted changes or unpushed commits, it needs to be set to `false`.",
"x-intellij-html-description": "when set to <code>true</code> will reset the cached repository to the latest commit from remote on every run. To use the cached repository with uncommitted changes or unpushed commits, it needs to be set to <code>false</code>."
}
},
"preferredOrder": [
"projectID",
"region",
"connection",
"repo",
"path",
"ref",
"sync"
],
"additionalProperties": false,
"type": "object",
"description": "contains information on the origin of skaffold configurations cloned from Google Cloud Build repository (2nd gen).",
"x-intellij-html-description": "contains information on the origin of skaffold configurations cloned from Google Cloud Build repository (2nd gen)."
},
"GoogleCloudStorageInfo": {
"properties": {
"path": {
Expand Down
27 changes: 27 additions & 0 deletions pkg/skaffold/schema/latest/config.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,30 @@ type GoogleCloudStorageInfo struct {
Sync *bool `yaml:"sync,omitempty"`
}

// GoogleCloudBuildRepoV2Info contains information on the origin of skaffold configurations cloned from Google Cloud Build repository (2nd gen).
type GoogleCloudBuildRepoV2Info struct {
// ProjectID is the ID of the GCP project where the repository is configured.
ProjectID string `yaml:"projectID" yamltags:"required"`

// Region is the GCP region where the repository is configured.
Region string `yaml:"region" yamltags:"required"`

// Connection is the name of the GCB repository connection associated with the repo.
Connection string `yaml:"connection" yamltags:"required"`

// Repo is the name of repository under the given connection.
Repo string `yaml:"repo" yamltags:"required"`

// Path is the relative path from the repo root to the skaffold configuration file. eg. `getting-started/skaffold.yaml`.
Path string `yaml:"path,omitempty"`

// Ref is the git ref the repo should be cloned from. e.g. `master` or `main`.
Ref string `yaml:"ref,omitempty"`

// Sync when set to `true` will reset the cached repository to the latest commit from remote on every run. To use the cached repository with uncommitted changes or unpushed commits, it needs to be set to `false`.
Sync *bool `yaml:"sync,omitempty"`
}

// ConfigDependency describes a dependency on another skaffold configuration.
type ConfigDependency struct {
// Names includes specific named configs within the file path. If empty, then all configs in the file are included.
Expand All @@ -135,6 +159,9 @@ type ConfigDependency struct {
// GoogleCloudStorage describes remote Google Cloud Storage objects containing the required configs.
GoogleCloudStorage *GoogleCloudStorageInfo `yaml:"googleCloudStorage,omitempty" yamltags:"oneOf=paths"`

// GoogleCloudBuildRepoV2 describes a [Google Cloud Build repository (2nd gen)](https://cloud.google.com/build/docs/repositories#repositories_2nd_gen) that points to a repo with the required configs.
GoogleCloudBuildRepoV2 *GoogleCloudBuildRepoV2Info `yaml:"googleCloudBuildRepoV2,omitempty" yamltags:"oneOf=paths"`

// ActiveProfiles describes the list of profiles to activate when resolving the required configs. These profiles must exist in the imported config.
ActiveProfiles []ProfileDependency `yaml:"activeProfiles,omitempty"`
}
Expand Down

0 comments on commit 61ed1d2

Please sign in to comment.