From 73b96a41bcbbeb1dfdf91b553ad069f71850a61a Mon Sep 17 00:00:00 2001 From: Andreas Ahlenstorf Date: Wed, 18 Feb 2026 16:49:44 +0100 Subject: [PATCH] chore: remove field ephemeral from runner registration response (#11350) Remove the field `ephemeral` from the response to runner registration requests made using the HTTP API (POST to `/repos/{owner}/{repo}/actions/runners` and friends) that was introduced with https://codeberg.org/forgejo/forgejo/pulls/9962. The client already knows that it requested an ephemeral runner. Therefore, the information is redundant. It can be included again should a compelling use case arise. This part of the HTTP API hasn't been released yet. Therefore, it is safe to remove the field. ## Checklist The [contributor guide](https://forgejo.org/docs/next/contributor/) contains information that will be helpful to first time contributors. There also are a few [conditions for merging Pull Requests in Forgejo repositories](https://codeberg.org/forgejo/governance/src/branch/main/PullRequestsAgreement.md). You are also welcome to join the [Forgejo development chatroom](https://matrix.to/#/#forgejo-development:matrix.org). ### Tests for Go changes (can be removed for JavaScript changes) - I added test coverage for Go changes... - [ ] in their respective `*_test.go` for unit tests. - [x] in the `tests/integration` directory if it involves interactions with a live Forgejo server. - I ran... - [x] `make pr-go` before pushing ### Tests for JavaScript changes (can be removed for Go changes) - I added test coverage for JavaScript changes... - [ ] in `web_src/js/*.test.js` if it can be unit tested. - [ ] in `tests/e2e/*.test.e2e.js` if it requires interactions with a live Forgejo server (see also the [developer guide for JavaScript testing](https://codeberg.org/forgejo/forgejo/src/branch/forgejo/tests/e2e/README.md#end-to-end-tests)). ### Documentation - [ ] I created a pull request [to the documentation](https://codeberg.org/forgejo/docs) to explain to Forgejo users how to use this change. - [x] I did not document these changes and I do not expect someone else to do it. ### Release notes - [ ] This change will be noticed by a Forgejo user or admin (feature, bug fix, performance, etc.). I suggest to include a release note for this change. - [x] This change is not visible to a Forgejo user or admin (refactor, dependency upgrade, etc.). I think there is no need to add a release note for this change. *The decision if the pull request will be shown in the release notes is up to the mergers / release team.* The content of the `release-notes/.md` file will serve as the basis for the release notes. If the file does not exist, the title of the pull request will be used instead. Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/11350 Reviewed-by: Mathieu Fenniak Co-authored-by: Andreas Ahlenstorf Co-committed-by: Andreas Ahlenstorf --- modules/structs/runner.go | 7 +++---- routers/api/v1/shared/runners.go | 7 +++---- templates/swagger/v1_json.tmpl | 4 ---- tests/integration/api_admin_actions_test.go | 3 --- tests/integration/api_org_actions_test.go | 3 --- tests/integration/api_repo_actions_test.go | 3 --- tests/integration/api_user_actions_test.go | 3 --- 7 files changed, 6 insertions(+), 24 deletions(-) diff --git a/modules/structs/runner.go b/modules/structs/runner.go index cecbb72400..5ac88f0488 100644 --- a/modules/structs/runner.go +++ b/modules/structs/runner.go @@ -25,8 +25,7 @@ type RegisterRunnerOptions struct { // RegisterRunnerResponse contains the details of the just registered runner. // swagger:model type RegisterRunnerResponse struct { - ID int64 `json:"id" binding:"Required"` - UUID string `json:"uuid" binding:"Required"` - Token string `json:"token" binding:"Required"` - Ephemeral bool `json:"ephemeral" binding:"Required"` + ID int64 `json:"id" binding:"Required"` + UUID string `json:"uuid" binding:"Required"` + Token string `json:"token" binding:"Required"` } diff --git a/routers/api/v1/shared/runners.go b/routers/api/v1/shared/runners.go index ad470215e9..a96a10ad30 100644 --- a/routers/api/v1/shared/runners.go +++ b/routers/api/v1/shared/runners.go @@ -170,10 +170,9 @@ func RegisterRunner(ctx *context.APIContext, ownerID, repoID int64) { } response := &structs.RegisterRunnerResponse{ - ID: runner.ID, - UUID: runner.UUID, - Token: runner.Token, - Ephemeral: runner.Ephemeral, + ID: runner.ID, + UUID: runner.UUID, + Token: runner.Token, } ctx.JSON(http.StatusCreated, response) } diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl index 976c25afa7..7e83814a2d 100644 --- a/templates/swagger/v1_json.tmpl +++ b/templates/swagger/v1_json.tmpl @@ -28538,10 +28538,6 @@ "type": "object", "title": "RegisterRunnerResponse contains the details of the just registered runner.", "properties": { - "ephemeral": { - "type": "boolean", - "x-go-name": "Ephemeral" - }, "id": { "type": "integer", "format": "int64", diff --git a/tests/integration/api_admin_actions_test.go b/tests/integration/api_admin_actions_test.go index 02644401fd..c935d352f9 100644 --- a/tests/integration/api_admin_actions_test.go +++ b/tests/integration/api_admin_actions_test.go @@ -376,7 +376,6 @@ func TestAPIAdminActionsRunnerOperations(t *testing.T) { assert.Positive(t, registerRunnerResponse.ID) assert.Equal(t, gouuid.Version(4), gouuid.MustParse(registerRunnerResponse.UUID).Version()) assert.Regexp(t, "(?i)^[0-9a-f]{40}$", registerRunnerResponse.Token) - assert.False(t, registerRunnerResponse.Ephemeral) registeredRunner := unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRunner{UUID: registerRunnerResponse.UUID}) assert.Equal(t, registerRunnerResponse.ID, registeredRunner.ID) @@ -402,8 +401,6 @@ func TestAPIAdminActionsRunnerOperations(t *testing.T) { var registerRunnerResponse *api.RegisterRunnerResponse DecodeJSON(t, response, ®isterRunnerResponse) - assert.True(t, registerRunnerResponse.Ephemeral) - registeredRunner := unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRunner{UUID: registerRunnerResponse.UUID}) assert.Equal(t, registerRunnerResponse.UUID, registeredRunner.UUID) assert.True(t, registeredRunner.Ephemeral) diff --git a/tests/integration/api_org_actions_test.go b/tests/integration/api_org_actions_test.go index f21723a751..35183306c2 100644 --- a/tests/integration/api_org_actions_test.go +++ b/tests/integration/api_org_actions_test.go @@ -250,7 +250,6 @@ func TestAPIOrgActionsRunnerOperations(t *testing.T) { assert.Positive(t, registerRunnerResponse.ID) assert.Equal(t, gouuid.Version(4), gouuid.MustParse(registerRunnerResponse.UUID).Version()) assert.Regexp(t, "(?i)^[0-9a-f]{40}$", registerRunnerResponse.Token) - assert.False(t, registerRunnerResponse.Ephemeral) registeredRunner := unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRunner{UUID: registerRunnerResponse.UUID}) assert.Equal(t, registerRunnerResponse.ID, registeredRunner.ID) @@ -276,8 +275,6 @@ func TestAPIOrgActionsRunnerOperations(t *testing.T) { var registerRunnerResponse *api.RegisterRunnerResponse DecodeJSON(t, response, ®isterRunnerResponse) - assert.True(t, registerRunnerResponse.Ephemeral) - registeredRunner := unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRunner{UUID: registerRunnerResponse.UUID}) assert.Equal(t, registerRunnerResponse.UUID, registeredRunner.UUID) assert.True(t, registeredRunner.Ephemeral) diff --git a/tests/integration/api_repo_actions_test.go b/tests/integration/api_repo_actions_test.go index 35cbc5d864..dfe33379d4 100644 --- a/tests/integration/api_repo_actions_test.go +++ b/tests/integration/api_repo_actions_test.go @@ -532,7 +532,6 @@ func TestAPIRepoActionsRunnerOperations(t *testing.T) { assert.Positive(t, registerRunnerResponse.ID) assert.Equal(t, gouuid.Version(4), gouuid.MustParse(registerRunnerResponse.UUID).Version()) assert.Regexp(t, "(?i)^[0-9a-f]{40}$", registerRunnerResponse.Token) - assert.False(t, registerRunnerResponse.Ephemeral) registeredRunner := unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRunner{UUID: registerRunnerResponse.UUID}) assert.Equal(t, registerRunnerResponse.ID, registeredRunner.ID) @@ -559,8 +558,6 @@ func TestAPIRepoActionsRunnerOperations(t *testing.T) { var registerRunnerResponse *api.RegisterRunnerResponse DecodeJSON(t, response, ®isterRunnerResponse) - assert.True(t, registerRunnerResponse.Ephemeral) - registeredRunner := unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRunner{UUID: registerRunnerResponse.UUID}) assert.Equal(t, registerRunnerResponse.UUID, registeredRunner.UUID) assert.True(t, registeredRunner.Ephemeral) diff --git a/tests/integration/api_user_actions_test.go b/tests/integration/api_user_actions_test.go index bdb763d5b2..304004659c 100644 --- a/tests/integration/api_user_actions_test.go +++ b/tests/integration/api_user_actions_test.go @@ -248,7 +248,6 @@ func TestAPIUserActionsRunnerOperations(t *testing.T) { assert.Positive(t, registerRunnerResponse.ID) assert.Equal(t, gouuid.Version(4), gouuid.MustParse(registerRunnerResponse.UUID).Version()) assert.Regexp(t, "(?i)^[0-9a-f]{40}$", registerRunnerResponse.Token) - assert.False(t, registerRunnerResponse.Ephemeral) registeredRunner := unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRunner{UUID: registerRunnerResponse.UUID}) assert.Equal(t, registerRunnerResponse.ID, registeredRunner.ID) @@ -274,8 +273,6 @@ func TestAPIUserActionsRunnerOperations(t *testing.T) { var registerRunnerResponse *api.RegisterRunnerResponse DecodeJSON(t, response, ®isterRunnerResponse) - assert.True(t, registerRunnerResponse.Ephemeral) - registeredRunner := unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRunner{UUID: registerRunnerResponse.UUID}) assert.Equal(t, registerRunnerResponse.UUID, registeredRunner.UUID) assert.True(t, registeredRunner.Ephemeral)