From 6e7e97f272956662469142453173ebbd6d019df1 Mon Sep 17 00:00:00 2001 From: danielhelfand Date: Thu, 5 Sep 2019 15:26:28 -0400 Subject: [PATCH] deprecation notice of results field for prs and trs --- api_compatibility_policy.md | 4 ++-- pkg/apis/pipeline/v1alpha1/pipelinerun_types.go | 7 ++++++- pkg/apis/pipeline/v1alpha1/taskrun_types.go | 7 ++++++- 3 files changed, 14 insertions(+), 4 deletions(-) diff --git a/api_compatibility_policy.md b/api_compatibility_policy.md index 18a5097838d..b58eb937c44 100644 --- a/api_compatibility_policy.md +++ b/api_compatibility_policy.md @@ -72,6 +72,6 @@ Backwards incompatible changes change the API, e.g. by removing fields from a CR spec. These changes will mean that folks using a previous version of the API will need to adjust their usage in order to use the new version. -These changes must be make [in a backwards compatible manner first](#backwards-compatible-changes-first), -and they must be improved by [more than half of the project OWNERS](OWNERS) +These changes must be made [in a backwards compatible manner first](#backwards-compatible-changes-first), +and the changes must be approved by [more than half of the project OWNERS](OWNERS) (i.e. 50% + 1). \ No newline at end of file diff --git a/pkg/apis/pipeline/v1alpha1/pipelinerun_types.go b/pkg/apis/pipeline/v1alpha1/pipelinerun_types.go index 2e918423e37..857e098a7a0 100644 --- a/pkg/apis/pipeline/v1alpha1/pipelinerun_types.go +++ b/pkg/apis/pipeline/v1alpha1/pipelinerun_types.go @@ -53,6 +53,9 @@ type PipelineRunSpec struct { ServiceAccount string `json:"serviceAccount"` // +optional ServiceAccounts []PipelineRunSpecServiceAccount `json:"serviceAccounts,omitempty"` + // Deprecation Notice: The field Results will be removed in v0.8.0 + // and should not be used. Plan to have this field removed before upgradring + // to v0.8.0. // +optional Results *Results `json:"results,omitempty"` // Used for cancelling a pipelinerun (and maybe more later on) @@ -112,7 +115,9 @@ type PipelineRef struct { type PipelineRunStatus struct { duckv1beta1.Status `json:",inline"` - // In #107 should be updated to hold the location logs have been uploaded to + // Deprecation Notice: The field Results will be removed in v0.8.0 + // and should not be used. Plan to have this field removed before upgradring + // to v0.8.0. // +optional Results *Results `json:"results,omitempty"` diff --git a/pkg/apis/pipeline/v1alpha1/taskrun_types.go b/pkg/apis/pipeline/v1alpha1/taskrun_types.go index 148b7bef0cd..61c6bbb5535 100644 --- a/pkg/apis/pipeline/v1alpha1/taskrun_types.go +++ b/pkg/apis/pipeline/v1alpha1/taskrun_types.go @@ -36,6 +36,9 @@ type TaskRunSpec struct { Inputs TaskRunInputs `json:"inputs,omitempty"` // +optional Outputs TaskRunOutputs `json:"outputs,omitempty"` + // Deprecation Notice: The field Results will be removed in v0.8.0 + // and should not be used. Plan to have this field removed before upgradring + // to v0.8.0. // +optional Results *Results `json:"results,omitempty"` // +optional @@ -115,7 +118,9 @@ var taskRunCondSet = apis.NewBatchConditionSet() type TaskRunStatus struct { duckv1beta1.Status `json:",inline"` - // In #107 should be updated to hold the location logs have been uploaded to + // Deprecation Notice: The field Results will be removed in v0.8.0 + // and should not be used. Plan to have this field removed before upgradring + // to v0.8.0. // +optional Results *Results `json:"results,omitempty"`