Restore missing descriptions in CloudBuildTrigger CRD#7115
Conversation
Restored missing descriptions in apis/cloudbuild/v1beta1/buildtrigger_types.go and regenerated the CRD. The descriptions were extracted from the previous version of the CRD before PR 6926. Fixes GoogleCloudPlatform#7114. This PR was generated by Overseer (powered by the gemini-3-flash-preview model).
codebot-robot
left a comment
There was a problem hiding this comment.
I've verified the CloudBuildTrigger CRD descriptions against the original version before PR 6926. All missing descriptions for both Spec and Status fields have been restored in buildtrigger_types.go and the CRD has been regenerated. I've also confirmed that the mapper code compiles by running 'go build ./pkg/controller/direct/cloudbuild/...'.\n\n*(This comment was generated by Overseer)*
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: cheftako The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
Thank you for the review and approval. I have confirmed that the CloudBuildTrigger CRD descriptions have been restored and the CRD has been regenerated. \n\n*(This comment was generated by Overseer)* |
a36fcf8
codebot-robot
left a comment
There was a problem hiding this comment.
The PR looks good and successfully restores the missing descriptions in the CRD and Go types.
I've left a few minor suggestions regarding the markdown formatting within the comments (e.g., using backticks for code literals and fields, and angle brackets for URLs). These are low-severity, nice-to-have improvements that would make the generated API reference documentation even easier to read.
(This review was generated by Overseer)
| // Builds created by this trigger will require approval before they execute. | ||
| // Any user with a Cloud Build Approver role for the project can approve a build. | ||
| type CloudBuildTriggerSpec_ApprovalConfig struct { | ||
| // Whether or not approval is needed. If this is set on a build, it will become pending when run, |
There was a problem hiding this comment.
It would be clearer to enclose run and pending in backticks if they refer to specific states.
| Name *string `json:"name,omitempty"` | ||
| // Allowed value: The `name` field of a `CloudBuildBitbucketServerConfig` resource. | ||
| External *string `json:"external,omitempty"` | ||
| // Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
There was a problem hiding this comment.
Consider placing the documentation URL in angle brackets <...> for better markdown parsing.
| type CloudBuildTriggerSpec_BitbucketServerTriggerConfig_PullRequest struct { | ||
| Branch *string `json:"branch,omitempty"` | ||
| // Regex of branches to match. | ||
| // The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax. |
There was a problem hiding this comment.
Consider enclosing the URL in angle brackets or backticks so it is rendered as a clickable link in standard markdown parsers.
| // Regex of branches to match. | ||
| // The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax. | ||
| Branch *string `json:"branch,omitempty"` | ||
| // Configure builds to run whether a repository owner or collaborator need to comment /gcbrun. Possible values: ["COMMENTS_DISABLED", "COMMENTS_ENABLED", "COMMENTS_ENABLED_FOR_EXTERNAL_CONTRIBUTORS_ONLY"]. |
There was a problem hiding this comment.
The /gcbrun command should be enclosed in backticks for better readability. Also consider formatting the possible values list as a comma-separated list of backticked strings.
| // Configure builds to run whether a repository owner or collaborator need to comment /gcbrun. Possible values: ["COMMENTS_DISABLED", "COMMENTS_ENABLED", "COMMENTS_ENABLED_FOR_EXTERNAL_CONTRIBUTORS_ONLY"]. | ||
| CommentControl *string `json:"commentControl,omitempty"` | ||
| InvertRegex *bool `json:"invertRegex,omitempty"` | ||
| // If true, branches that do NOT match the git_ref will trigger a build. |
There was a problem hiding this comment.
Consider wrapping git_ref in backticks to clearly indicate it's referring to a variable/field name.
| // Service crypto key. These values must be specified in the build's Secret. These variables | ||
| // will be available to all build steps in this build. | ||
| SecretEnv []string `json:"secretEnv,omitempty"` | ||
| // Requested hash for SourceProvenance. Possible values: ["NONE", "SHA256", "MD5"]. |
There was a problem hiding this comment.
Consider formatting the possible values as a markdown list or wrapping the array literal in backticks.
| // Option to specify behavior when there is an error in the substitution checks. | ||
| // | ||
| // NOTE this is always set to ALLOW_LOOSE for triggered builds and cannot be overridden | ||
| // in the build configuration file. Possible values: ["MUST_MATCH", "ALLOW_LOOSE"]. |
There was a problem hiding this comment.
Consider formatting the possible values as a markdown list or wrapping the array literal in backticks.
| // the builder service account's credentials if necessary. | ||
| // | ||
| // The Docker daemon's cache will already have the latest versions of all of | ||
| // the officially supported build steps (see https://github.com/GoogleCloudPlatform/cloud-builders |
There was a problem hiding this comment.
Consider wrapping the URL in angle brackets <...> for better markdown parsing.
| // The path of the file, with the repo root as the root of the path. | ||
| Path *string `json:"path,omitempty"` | ||
| // The type of the repo, since it may not be explicit from the repo field (e.g from a URL). | ||
| // Values can be UNKNOWN, CLOUD_SOURCE_REPOSITORIES, GITHUB, BITBUCKET_SERVER Possible values: ["UNKNOWN", "CLOUD_SOURCE_REPOSITORIES", "GITHUB", "BITBUCKET_SERVER"]. |
There was a problem hiding this comment.
Consider formatting the possible values as a markdown list or wrapping the array literal in backticks.
| // If unspecified, the repo from which the trigger invocation originated is assumed to be the repo from which to read the specified path. | ||
| RepositoryRef *CloudBuildTriggerSpec_GitFileSource_RepositoryRef `json:"repositoryRef,omitempty"` | ||
| // The branch, tag, arbitrary ref, or SHA version of the repo to use when resolving the | ||
| // filename (optional). This field respects the same syntax/resolution as described here: https://git-scm.com/docs/gitrevisions |
There was a problem hiding this comment.
Consider wrapping the URL in angle brackets <...> for better markdown parsing.
Restored missing descriptions in apis/cloudbuild/v1beta1/buildtrigger_types.go and regenerated the CRD.
The descriptions were extracted from the previous version of the CRD before PR 6926.
Fixes #7114.
This PR was generated by Overseer (powered by the gemini-3-flash-preview model).