Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
3624fc65
Commit
3624fc65
authored
Jan 26, 2022
by
Pedro Pombeiro
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add deprecation post
parent
67410860
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
65 additions
and
2 deletions
+65
-2
data/deprecations/14-5-runner-api-status-does-contain-paused.yml
...precations/14-5-runner-api-status-does-contain-paused.yml
+1
-1
data/deprecations/14-8-runner-api-active-field-replaced-with-paused-breaking-change.yml
...api-active-field-replaced-with-paused-breaking-change.yml
+33
-0
doc/update/deprecations.md
doc/update/deprecations.md
+31
-1
No files found.
data/deprecations/14-5-runner-api-status-does-contain-paused.yml
View file @
3624fc65
-
name
:
"
REST
API
Runner
will
not
contai
n
`paused`"
-
name
:
"
REST
and
GraphQL
API
Runner
status
will
not
retur
n
`paused`"
announcement_milestone
:
"
14.5"
# The milestone when this feature was first announced as deprecated.
announcement_date
:
"
2021-11-22"
removal_milestone
:
"
15.0"
# the milestone when this feature is planned to be removed
...
...
data/deprecations/14-8-runner-api-active-field-replaced-with-paused-breaking-change.yml
0 → 100644
View file @
3624fc65
-
name
:
"
REST
and
GraphQL
API
Runner
usage
of
`active`
replaced
by
`paused`"
announcement_milestone
:
"
14.8"
announcement_date
:
"
2022-02-22"
removal_milestone
:
"
15.0"
removal_date
:
"
2022-05-22"
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 15.0, namely:
- 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:
- `GET /runners`
- `GET /runners/all`
- `GET /runners/:id` / `PUT /runners/:id`
- `PUT --form "active=false" /runners/:runner_id`
- `GET /projects/:id/runners` / `POST /projects/:id/runners`
- `GET /groups/:id/runners`
The 15.0 release of the GitLab Runner will start using the `paused` property when registering runners, and therefore
will only be compatible with GitLab 15.0 and later. Until 15.0, GitLab will accept the deprecated `active` flag from
existing runners.
stage
:
Verify
tiers
:
[
Core
,
Premium
,
Ultimate
]
issue_url
:
https://gitlab.com/gitlab-org/gitlab/-/issues/347211
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
doc/update/deprecations.md
View file @
3624fc65
...
...
@@ -226,7 +226,7 @@ In milestone 15.0, we will remove the `pipelines` attribute from the API respons
**Planned removal milestone: 15.0 (2022-05-22)**
### REST
API Runner will not contai
n `paused`
### REST
and GraphQL API Runner status will not retur
n `paused`
WARNING:
This feature will be changed or removed in 15.0
...
...
@@ -717,6 +717,36 @@ The `merged_by` field in the [merge request API](https://docs.gitlab.com/ee/api/
## 14.8
### REST and GraphQL API Runner usage of `active` replaced by `paused`
WARNING:
This feature will be changed or removed in 15.0
as a
[
breaking change
](
https://docs.gitlab.com/ee/development/contributing/#breaking-changes
)
.
Before updating GitLab, review the details carefully to determine if you need to make any
changes to your code, settings, or workflow.
Occurrences of the
`active`
identifier in the GitLab Runner REST and GraphQL API endpoints will be
renamed to
`paused`
in GitLab 15.0, namely:
-
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:
-
`GET /runners`
-
`GET /runners/all`
-
`GET /runners/:id`
/
`PUT /runners/:id`
-
`PUT --form "active=false" /runners/:runner_id`
-
`GET /projects/:id/runners`
/
`POST /projects/:id/runners`
-
`GET /groups/:id/runners`
The 15.0 release of the GitLab Runner will start using the
`paused`
property when registering runners, and therefore
will only be compatible with GitLab 15.0 and later. Until 15.0, GitLab will accept the deprecated
`active`
flag from
existing runners.
**Planned removal milestone: 15.0 (2022-05-22)**
### Vulnerability Check
WARNING:
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment