From ee664acb356f8123f4f6b00b73c1e1cf0866c7fb Mon Sep 17 00:00:00 2001 From: GitLab Bot Date: Thu, 20 Oct 2022 09:40:42 +0000 Subject: Add latest changes from gitlab-org/gitlab@15-5-stable-ee --- .../14-5-runner-api-status-does-contain-paused.yml | 5 +++-- ...e-field-replaced-with-paused-breaking-change.yml | 21 ++++++++++----------- ...14-8-runner-api-project_type-breaking-change.yml | 15 --------------- ...i-status-filter-does-accept-active-or-paused.yml | 11 +++++++---- .../15-5-confidential-field-on-notes.yml | 12 ++++++++++++ .../15-5-vulnerabilityFindingDismiss-mutation.yml | 13 +++++++++++++ .../templates/_deprecation_template.md.erb | 2 +- data/removals/templates/_removal_template.md.erb | 2 +- 8 files changed, 47 insertions(+), 34 deletions(-) delete mode 100644 data/deprecations/14-8-runner-api-project_type-breaking-change.yml create mode 100644 data/deprecations/15-5-confidential-field-on-notes.yml create mode 100644 data/deprecations/15-5-vulnerabilityFindingDismiss-mutation.yml (limited to 'data') diff --git a/data/deprecations/14-5-runner-api-status-does-contain-paused.yml b/data/deprecations/14-5-runner-api-status-does-contain-paused.yml index 5acfac45ca2..41124638509 100644 --- a/data/deprecations/14-5-runner-api-status-does-contain-paused.yml +++ b/data/deprecations/14-5-runner-api-status-does-contain-paused.yml @@ -1,11 +1,12 @@ -- name: "REST and GraphQL API Runner status will not return `paused`" +- name: "GraphQL API Runner status will not return `paused`" announcement_milestone: "14.5" # The milestone when this feature was first announced as deprecated. announcement_date: "2021-11-22" removal_milestone: "16.0" # the milestone when this feature is planned to be removed removal_date: "2023-04-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. - The GitLab Runner REST and GraphQL API endpoints will not return `paused` or `active` as a status in GitLab 16.0. + The GitLab Runner GraphQL API endpoints will not return `paused` or `active` as a status in GitLab 16.0. + In a future v5 of the REST API, the endpoints for GitLab Runner will also not return `paused` or `active`. A runner's status will only relate to runner contact status, such as: `online`, `offline`, or `not_connected`. Status `paused` or `active` will no longer appear. diff --git a/data/deprecations/14-8-runner-api-active-field-replaced-with-paused-breaking-change.yml b/data/deprecations/14-8-runner-api-active-field-replaced-with-paused-breaking-change.yml index 99af852c13e..223c1439191 100644 --- a/data/deprecations/14-8-runner-api-active-field-replaced-with-paused-breaking-change.yml +++ b/data/deprecations/14-8-runner-api-active-field-replaced-with-paused-breaking-change.yml @@ -6,15 +6,16 @@ breaking_change: true reporter: pedropombeiro body: | - Occurrences of the `active` identifier in the GitLab Runner REST and GraphQL API endpoints will be - renamed to `paused` in GitLab 16.0, namely: + Occurrences of the `active` identifier in the GitLab Runner GraphQL API endpoints will be + renamed to `paused` in GitLab 16.0. - - GraphQL API: - - the `CiRunner` property; - - the `RunnerUpdateInput` input type for the `runnerUpdate` mutation; - - the `runners` and `Group.runners` queries. - - REST API: - - endpoints taking or returning `active` properties, such as: + - For the GraphQL API, this change affects: + - the `CiRunner` property + - the `RunnerUpdateInput` input type for the `runnerUpdate` mutation + - the `runners` and `Group.runners` queries + - In v4 of the REST API, starting in GitLab 14.8, you can use the `paused` property in place of `active` + - In v5 of the REST API, this change will affect: + - endpoints taking or returning `active` property, such as: - `GET /runners` - `GET /runners/all` - `GET /runners/:id` / `PUT /runners/:id` @@ -22,9 +23,7 @@ - `GET /projects/:id/runners` / `POST /projects/:id/runners` - `GET /groups/:id/runners` - The 16.0 release of the GitLab Runner will start using the `paused` property when registering runners, and therefore - will only be compatible with GitLab 16.0 and later. Until 16.0, GitLab will accept the deprecated `active` flag from - existing runners. + The 16.0 release of GitLab Runner will start using the `paused` property when registering runners. stage: Verify tiers: [Core, Premium, Ultimate] issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/351109 diff --git a/data/deprecations/14-8-runner-api-project_type-breaking-change.yml b/data/deprecations/14-8-runner-api-project_type-breaking-change.yml deleted file mode 100644 index d965d830c58..00000000000 --- a/data/deprecations/14-8-runner-api-project_type-breaking-change.yml +++ /dev/null @@ -1,15 +0,0 @@ -- name: "REST API endpoint to list group runners no longer accepts `project_type` value for `type` argument" - announcement_milestone: "14.8" - announcement_date: "2022-02-22" - removal_milestone: "16.0" - removal_date: "2023-04-22" - breaking_change: true - reporter: pedropombeiro - body: | - The `GET /groups/:id/runners?type=project_type` endpoint will be removed in GitLab 16.0. The endpoint always returned an empty collection. - stage: Verify - tiers: [Core, Premium, Ultimate] - issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/351466 - documentation_url: https://docs.gitlab.com/ee/api/runners.html - 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 diff --git a/data/deprecations/14-8-runner-api-status-filter-does-accept-active-or-paused.yml b/data/deprecations/14-8-runner-api-status-filter-does-accept-active-or-paused.yml index 174e51f5f5d..376a27c8863 100644 --- a/data/deprecations/14-8-runner-api-status-filter-does-accept-active-or-paused.yml +++ b/data/deprecations/14-8-runner-api-status-filter-does-accept-active-or-paused.yml @@ -1,17 +1,20 @@ -- name: "REST API Runner will not accept `status` filter values of `active` or `paused`" +- name: "GraphQL API Runner will not accept `status` filter values of `active` or `paused`" announcement_milestone: "14.8" # The milestone when this feature was first announced as deprecated. announcement_date: "2022-02-22" removal_milestone: "16.0" removal_date: "2023-04-22" breaking_change: true body: | # Do not modify this line, instead modify the lines below. - The GitLab Runner REST endpoints will stop accepting `paused` or `active` as a status value in GitLab 16.0. + The GitLab Runner GraphQL endpoints will stop accepting `paused` or `active` as a status value in GitLab 16.0. A runner's status will only relate to runner contact status, such as: `online`, `offline`. Status values `paused` or `active` will no longer be accepted and will be replaced by the `paused` query parameter. - When checking for paused runners, API users are advised to specify `paused=true` as the query parameter. - When checking for active runners, specify `paused=false`. + When checking for paused runners, API users are advised to specify `paused: true` as the query parameter. + When checking for active runners, specify `paused: false`. + + The REST API endpoints will follow in the same direction in a future REST v5 API, however the new `paused` + status value can be used in place of `active` since GitLab 14.8. stage: Verify tiers: [Core, Premium, Ultimate] issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/351109 diff --git a/data/deprecations/15-5-confidential-field-on-notes.yml b/data/deprecations/15-5-confidential-field-on-notes.yml new file mode 100644 index 00000000000..5ec5c3adab9 --- /dev/null +++ b/data/deprecations/15-5-confidential-field-on-notes.yml @@ -0,0 +1,12 @@ +- name: 'GraphQL field `confidential` changed to `internal` on notes' + announcement_milestone: '15.5' + announcement_date: '2022-10-22' + removal_milestone: '16.0' + removal_date: '2023-05-22' + breaking_change: true + reporter: nicolasdular + stage: plan + issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/371485 + body: | + The `confidential` field for a `Note` will be deprecated and renamed to `internal`. + documentation_url: https://docs.gitlab.com/ee/api/graphql/reference/index.html#note diff --git a/data/deprecations/15-5-vulnerabilityFindingDismiss-mutation.yml b/data/deprecations/15-5-vulnerabilityFindingDismiss-mutation.yml new file mode 100644 index 00000000000..949aa40e5ce --- /dev/null +++ b/data/deprecations/15-5-vulnerabilityFindingDismiss-mutation.yml @@ -0,0 +1,13 @@ +- name: "vulnerabilityFindingDismiss GraphQL mutation" + announcement_milestone: "15.5" + announcement_date: "2022-10-22" + removal_milestone: "16.0" + removal_date: "2023-05-22" + breaking_change: true + reporter: matt_wilson + stage: govern + issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/375645 + body: | + The `VulnerabilityFindingDismiss` GraphQL mutation is being deprecated and will be removed in GitLab 16.0. This mutation was not used often as the Vulnerability Finding ID was not available to users (this field was [deprecated in 15.3](https://docs.gitlab.com/ee/update/deprecations.html#use-of-id-field-in-vulnerabilityfindingdismiss-mutation)). Users should instead use `VulnerabilityDismiss` to dismiss vulnerabilities in the Vulnerability Report or `SecurityFindingDismiss` for security findings in the CI Pipeline Security tab. + tiers: "Ultimate" + documentation_url: https://docs.gitlab.com/ee/api/graphql/reference/index.html#mutationvulnerabilityfindingdismiss diff --git a/data/deprecations/templates/_deprecation_template.md.erb b/data/deprecations/templates/_deprecation_template.md.erb index 0725ce2891e..4fd2ca29bc8 100644 --- a/data/deprecations/templates/_deprecation_template.md.erb +++ b/data/deprecations/templates/_deprecation_template.md.erb @@ -1,7 +1,7 @@ --- stage: none group: none -info: "See the Technical Writers assigned to Development Guidelines: https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments-to-development-guidelines" +info: "See the Technical Writers assigned to Development Guidelines: https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-development-guidelines" --- # Deprecations by version diff --git a/data/removals/templates/_removal_template.md.erb b/data/removals/templates/_removal_template.md.erb index dc779323096..ad0298a6596 100644 --- a/data/removals/templates/_removal_template.md.erb +++ b/data/removals/templates/_removal_template.md.erb @@ -1,7 +1,7 @@ --- stage: none group: none -info: "See the Technical Writers assigned to Development Guidelines: https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments-to-development-guidelines" +info: "See the Technical Writers assigned to Development Guidelines: https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-development-guidelines" --- # Removals by version -- cgit v1.2.3