Add removal date to deprecation docs

d967c844 · Arturo Herrero · e240658a · d967c844 · d967c844 · d967c844
Commit d967c844 authored Dec 09, 2021 by Arturo Herrero
3 changed files
--- a/data/deprecations/templates/_deprecation_template.md.erb
+++ b/data/deprecations/templates/_deprecation_template.md.erb
@@ -44,6 +44,7 @@ For deprecation reviewers (Technical Writers only):
 <%= deprecation["body"] -%>

 Announced: <%= deprecation["announcement_date"]%>
+Planned removal: <%= deprecation["removal_date"]%>
    <%- end -%>
  <%- end -%>
 <%- else -%>

--- a/data/deprecations/templates/example.yml
+++ b/data/deprecations/templates/example.yml
@@ -14,6 +14,7 @@
  announcement_milestone: "XX.YY" # The milestone when this feature was first announced as deprecated.
  announcement_date: "YYYY-MM-DD" # 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: "XX.YY" # The milestone when this feature is planned to be removed
+  removal_date: "YYYY-MM-DD" # This should almost always be the 22nd of a month (YYYY-MM-22), the date of the milestone release when this feature is planned to be removed.
  body: | # Do not modify this line, instead modify the lines below.
    <!-- START OF BODY COMMENT

@@ -29,4 +30,3 @@
  documentation_url: # (optional) This is a link to the current documentation page
  image_url: # (optional) This is a link to a thumbnail image depicting the feature
  video_url: # (optional) Use the youtube thumbnail URL with the structure of https://img.youtube.com/vi/UNIQUEID/hqdefault.jpg
-  removal_date: # (optional - may be required in the future) YYYY-MM-DD format. This should almost always be the 22nd of a month (YYYY-MM-22), the date of the milestone release when this feature is planned to be removed
--- a/doc/update/deprecations.md
+++ b/doc/update/deprecations.md
@@ -45,6 +45,7 @@ The Task Runner pod is used to execute periodic housekeeping tasks within the Gi
 This will result in the rename of the sub-chart: `gitlab/task-runner` to `gitlab/toolbox`. Resulting pods will be named along the lines of `{{ .Release.Name }}-toolbox`, which will often be `gitlab-toolbox`. They will be locatable with the label `app=toolbox`.

 Announced: 2021-08-22
+Planned removal: 2021-11-22

 ## 14.6

@@ -53,6 +54,7 @@ Announced: 2021-08-22
 The [release-cli](https://gitlab.com/gitlab-org/release-cli) will be released as a [generic package](https://gitlab.com/gitlab-org/release-cli/-/packages) starting in GitLab 14.2. We will continue to deploy it as a binary to S3 until GitLab 14.5 and stop distributing it in S3 in GitLab 14.6.

 Announced: 2021-08-22
+Planned removal: 2021-12-22

 ## 14.8

@@ -63,6 +65,7 @@ Distribution support and security updates for openSUSE Leap 15.2 are [ending Dec
 Starting in 14.5 we are providing packages for openSUSE Leap 15.3, and will stop providing packages for openSUSE Leap 15.2 in the 14.8 milestone.

 Announced: 2021-11-22
+Planned removal: 

 ## 15.0

@@ -83,12 +86,14 @@ feature flag. Enabling them can cause too many events to be generated which can
 dramatically slow down GitLab instances. For this reason, they are being removed.

 Announced: 2021-09-22
+Planned removal: 

 ### CI/CD job name length limit

 In GitLab 15.0 we are going to limit the number of characters in CI/CD job names to 255. Any pipeline with job names that exceed the 255 character limit will stop working after the 15.0 release.

 Announced: 2021-12-22
+Planned removal: 

 ### Certificate-based integration with Kubernetes

@@ -103,12 +108,14 @@ For a more robust, secure, forthcoming, and reliable integration with Kubernetes
 [Kubernetes Agent](https://docs.gitlab.com/ee/user/clusters/agent/) to connect Kubernetes clusters with GitLab.

 Announced: 2021-11-15
+Planned removal: 

 ### Converting an instance (shared) runner to a project (specific) runner is deprecated

 In GitLab 15.0, we will remove the feature that enables you to convert an instance (shared) runner to a project (specific) runner. Users who need to add a runner to only a particular project can register a runner to the project directly.

 Announced: 2021-11-22
+Planned removal: 

 ### Deprecate `Versions` on base `PackageType`

@@ -117,6 +124,7 @@ As part of the work to create a [Package Registry GraphQL API](https://gitlab.co
 In milestone 15.0, we will completely remove `Version` from `PackageType`.

 Announced: 2021-11-22
+Planned removal: 

 ### Deprecate legacy approval status names from License Compliance API

@@ -131,6 +139,7 @@ Announced: 2021-12-22
 Long term service and support (LTSS) for SUSE Linux Enterprise Server (SLES) 12 SP2 [ended on March 31, 2021](https://www.suse.com/lifecycle/). The CA certificates on SP2 include the expired DST root certificate, and it's not getting new CA certificate package updates. We have implemented some [workarounds](https://gitlab.com/gitlab-org/gitlab-omnibus-builder/-/merge_requests/191), but we will not be able to continue to keep the build running properly.

 Announced: 2021-11-22
+Planned removal: 

 ### Deprecation of Runner status `not_connected` API value

@@ -156,6 +165,7 @@ Announced: 2021-12-22
 We decided to remove the GitLab Serverless features as they never really resonated with our users. Besides, given the continuous development of Kubernetes and Knative, our current implementations do not even work with recent versions.

 Announced: 2021-09-22
+Planned removal: 

 ### Known host required for GitLab Runner SSH executor

@@ -164,6 +174,7 @@ In [GitLab 14.3](https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/30
 In GitLab 15.0 and later, the default value for this configuration option will change from `true` to `false`. This means that strict host key checking will be enforced when using the GitLab Runner SSH executor.

 Announced: 2021-11-22
+Planned removal: 

 ### Legacy database configuration

@@ -174,6 +185,7 @@ supported using a single PostgreSQL adapter, whereas the new format is changing
 This deprecation mainly impacts users compiling GitLab from source because Omnibus will handle this configuration automatically.

 Announced: 2021-09-22
+Planned removal: 

 ### Must explicitly assign `AuthenticationType` for `[runners.cache.s3]`

@@ -182,6 +194,7 @@ In GitLab 15.0 and later, to access the AWS S3 cache, you must specify the `Auth
 Prior to 14.5, if you did not define the `AuthenticationType`, GitLab Runner chose a type for you.

 Announced: 2021-11-22
+Planned removal: 

 ### NFS for Git repository storage deprecated

@@ -196,6 +209,7 @@ Gitaly Cluster offers tremendous benefits for our customers such as:
 We encourage customers currently using NFS for Git repositories to plan their migration by reviewing our documentation on [migrating to Gitaly Cluster](https://docs.gitlab.com/ee/administration/gitaly/index.html#migrate-to-gitaly-cluster).

 Announced: 2021-06-22
+Planned removal: 2022-05-22

 ### OmniAuth Kerberos gem

@@ -206,6 +220,7 @@ This gem has not been maintained and has very little usage. We therefore plan to
 Note that we are not deprecating the Kerberos SPNEGO integration, only the old password-based Kerberos integration.

 Announced: 2021-09-22
+Planned removal: 

 ### Package pipelines in API payload is paginated

@@ -214,6 +229,7 @@ A request to the API for `/api/v4/projects/:id/packages` returns a paginated res
 In milestone 15.0, we will remove the `pipelines` attribute from the API response.

 Announced: 2021-11-22
+Planned removal: 

 ### REST API Runner will not contain `paused`

@@ -226,30 +242,35 @@ When checking if a runner is `paused`, API users are advised to check the boolea
 `active` to be `false` instead. When checking if a runner is `active`, check if `active` is `true`.

 Announced: 2021-11-22
+Planned removal: 

 ### Removal of `defaultMergeCommitMessageWithDescription` GraphQL API field

 The GraphQL API field `defaultMergeCommitMessageWithDescription` has been deprecated and will be removed in GitLab 15.0. For projects with a commit message template set, it will ignore the template.

 Announced: 2021-11-22
+Planned removal: 

 ### Removal of `promote-db` command from `gitlab-ctl`

 In GitLab 14.5, we introduced the command `gitlab-ctl promote` to promote any Geo secondary node to a primary during a failover. This command replaces `gitlab-ctl promote-db` which is used to promote database nodes in multi-node Geo secondary sites. `gitlab-ctl promote-db` will continue to function as-is and be available until GitLab 15.0. We recommend that Geo customers begin testing the new `gitlab-ctl promote` command in their staging environments and incorporating the new command in their failover procedures.

 Announced: 2021-11-22
+Planned removal: 2022-05-22

 ### Removal of `promote-to-primary-node` command from `gitlab-ctl`

 In GitLab 14.5, we introduced the command `gitlab-ctl promote` to promote any Geo secondary node to a primary during a failover. This command replaces `gitlab-ctl promote-to-primary-node` which was only usable for single-node Geo sites. `gitlab-ctl promote-to-primary-node` will continue to function as-is and be available until GitLab 15.0. We recommend that Geo customers begin testing the new `gitlab-ctl promote` command in their staging environments and incorporating the new command in their failover procedures.

 Announced: 2021-11-22
+Planned removal: 2022-05-22

 ### Remove `type` and `types` keyword in CI/CD configuration

 The `type` and `types` CI/CD keywords will be removed in GitLab 15.0. Pipelines that use these keywords will stop working, so you must switch to `stage` and `stages`, which have the same behavior.

 Announced: 2021-12-22
+Planned removal: 

 ### Remove the `:dependency_proxy_for_private_groups` feature flag

@@ -258,6 +279,7 @@ We added a feature flag because [GitLab-#11582](https://gitlab.com/gitlab-org/gi
 In milestone 15.0, we will remove the feature flag entirely. Moving forward, you must authenticate when using the Dependency Proxy.

 Announced: 2021-11-22
+Planned removal: 

 ### Remove the `pipelines` field from the `version` field

@@ -269,6 +291,7 @@ In GraphQL, there are two `pipelines` fields that you can use in a [`PackageDeta
 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.

 Announced: 2021-11-22
+Planned removal: 

 ### Update to the Container Registry group-level API

@@ -277,6 +300,7 @@ In milestone 15.0, support for the `tags` and `tags_count` parameters will be re
 The `GET /groups/:id/registry/repositories` endpoint will remain, but won't return any info about tags. To get the info about tags, you can use the existing `GET /registry/repositories/:id` endpoint, which will continue to support the `tags` and `tag_count` options as it does today. The latter must be called once per image repository.

 Announced: 2021-11-22
+Planned removal: 

 ### Value Stream Analytics filtering calculation change

@@ -285,6 +309,7 @@ We are changing how the date filter works in Value Stream Analytics. Instead of
 If you monitor Value Stream Analytics metrics and rely on the date filter, to avoid losing data, you must save the data prior to this change.

 Announced: 2021-11-22
+Planned removal: 

 ### apiFuzzingCiConfigurationCreate GraphQL mutation

@@ -293,3 +318,4 @@ API request anymore. We are therefore deprecating the `apiFuzzingCiConfiguration
 which isn't being used in GitLab anymore.

 Announced: 2021-12-22
+Planned removal: 2022-05-22