diff --git a/app/graphql/types/query_type.rb b/app/graphql/types/query_type.rb index abfa2e63bbb5358ccda306e06bd64336854d8351..f0430a47a7fe45f40a99941341bf3ca123f172d6 100644 --- a/app/graphql/types/query_type.rb +++ b/app/graphql/types/query_type.rb @@ -94,8 +94,10 @@ class QueryType < ::Types::BaseObject resolver: Resolvers::Ci::RunnerResolver, extras: [:lookahead], description: "Find a runner." - field :runner_platforms, resolver: Resolvers::Ci::RunnerPlatformsResolver - field :runner_setup, resolver: Resolvers::Ci::RunnerSetupResolver + field :runner_platforms, resolver: Resolvers::Ci::RunnerPlatformsResolver, + deprecated: { reason: 'No longer used, use gitlab-runner documentation to learn about supported platforms', milestone: '15.9' } + field :runner_setup, resolver: Resolvers::Ci::RunnerSetupResolver, + deprecated: { reason: 'No longer used, use gitlab-runner documentation to learn about runner registration commands', milestone: '15.9' } field :runners, Types::Ci::RunnerType.connection_type, null: true, resolver: Resolvers::Ci::RunnersResolver, diff --git a/data/deprecations/15-9-deprecate-runner-setup-instructions-api.yml b/data/deprecations/15-9-deprecate-runner-setup-instructions-api.yml new file mode 100644 index 0000000000000000000000000000000000000000..4f5c301b7c23882ee9cf994660c77f744997e120 --- /dev/null +++ b/data/deprecations/15-9-deprecate-runner-setup-instructions-api.yml @@ -0,0 +1,13 @@ +- title: 'GitLab Runner platforms and setup instructions in GraphQL API' + announcement_milestone: '15.9' + announcement_date: '2023-02-22' + removal_milestone: '17.0' + removal_date: '2024-05-22' + breaking_change: true + reporter: mrincon + body: | + The `runnerPlatforms` and `runnerSetup` queries to get GitLab Runner platforms and installation instructions + are deprecated and will be removed from the GraphQL API. For installation instructions, you should use the + [GitLab Runner documentation](https://docs.gitlab.com/runner/) + stage: verify + issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/387937 diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index 8a03c152acbc81a2fab965d60f46bf844a975250..e57ca9230bd59ae66c3d6bb3a3ac9305b684a8de 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -414,6 +414,10 @@ Returns [`CiRunner`](#cirunner). Supported runner platforms. +WARNING: +**Deprecated** in 15.9. +No longer used, use gitlab-runner documentation to learn about supported platforms. + Returns [`RunnerPlatformConnection`](#runnerplatformconnection). This field returns a [connection](#connections). It accepts the @@ -424,6 +428,10 @@ four standard [pagination arguments](#connection-pagination-arguments): Runner setup instructions. +WARNING: +**Deprecated** in 15.9. +No longer used, use gitlab-runner documentation to learn about runner registration commands. + Returns [`RunnerSetup`](#runnersetup). #### Arguments diff --git a/doc/update/deprecations.md b/doc/update/deprecations.md index 6840aa6108e86fbb5c1c7dbd63fc4dcad0f1e60f..763b82f9010a093a29bbb137f922ec86ae426882 100644 --- a/doc/update/deprecations.md +++ b/doc/update/deprecations.md @@ -66,6 +66,22 @@ Due to limited customer usage, Browser Performance Testing is deprecated and wil <div class="deprecation removal-170 breaking-change"> +### GitLab Runner platforms and setup instructions in GraphQL API + +Planned removal: GitLab <span class="removal-milestone">17.0</span> <span class="removal-date"></span> + +WARNING: +This is a [breaking change](https://docs.gitlab.com/ee/development/deprecation_guidelines/). +Review the details carefully before upgrading. + +The `runnerPlatforms` and `runnerSetup` queries to get GitLab Runner platforms and installation instructions +are deprecated and will be removed from the GraphQL API. For installation instructions, you should use the +[GitLab Runner documentation](https://docs.gitlab.com/runner/) + +</div> + +<div class="deprecation removal-170 breaking-change"> + ### Load Performance Testing is deprecated Planned removal: GitLab <span class="removal-milestone">17.0</span> <span class="removal-date"></span>