summaryrefslogtreecommitdiff
path: root/data/deprecations/14-5-remove-pipelines-from-version-field.yml
diff options
context:
space:
mode:
Diffstat (limited to 'data/deprecations/14-5-remove-pipelines-from-version-field.yml')
-rw-r--r--data/deprecations/14-5-remove-pipelines-from-version-field.yml16
1 files changed, 16 insertions, 0 deletions
diff --git a/data/deprecations/14-5-remove-pipelines-from-version-field.yml b/data/deprecations/14-5-remove-pipelines-from-version-field.yml
new file mode 100644
index 00000000000..917442219e5
--- /dev/null
+++ b/data/deprecations/14-5-remove-pipelines-from-version-field.yml
@@ -0,0 +1,16 @@
+- name: "Remove the `pipelines` field from the `version` field" # The name of the feature to be deprecated
+ announcement_milestone: "14.5" # The milestone when this feature was first announced as deprecated.
+ announcement_date: "2021-11-22" # The date of the milestone release when this feature was first announced as deprecated. This should almost always be the 22nd of a month (YYYY-MM-22), unless you did an out of band blog post.
+ removal_milestone: "15.0" # The milestone when this feature is planned to be removed
+ removal_date: "2022-05-22" # The date of the milestone release when this feature is planned to be removed
+ breaking_change: true
+ body: | # Do not modify this line, instead modify the lines below.
+ In GraphQL, there are two `pipelines` fields that you can use in a [`PackageDetailsType`](https://docs.gitlab.com/ee/api/graphql/reference/#packagedetailstype) to get the pipelines for package versions:
+
+ - The `versions` field's `pipelines` field. This returns all the pipelines associated with all the package's versions, which can pull an unbounded number of objects in memory and create performance concerns.
+ - The `pipelines` field of a specific `version`. This returns only the pipelines associated with that single package version.
+
+ To mitigate possible performance problems, we will remove the `versions` field's `pipelines` field in milestone 15.0. Although you will no longer be able to get all pipelines for all versions of a package, you can still get the pipelines of a single version through the remaining `pipelines` field for that version.
+ stage: package
+ tiers: Free
+ issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/342882