forgejo in the example) with a value of your liking.",
+ "actions.runners.runner_setup.heading_using_options": "Using program options",
+ "actions.runners.runner_setup.instruction_advanced_configurations": "For configuring Forgejo Runner running in containers or advanced configurations, see the documentation.",
"actions.runners.none": "No runners available",
- "actions.runners.version": "Version",
+ "actions.runners.reset_registration_token.token": "Registration Token (Deprecated)",
"actions.runners.reset_registration_token.button": "Reset registration token",
"actions.runners.reset_registration_token.success": "Runner registration token reset successfully",
"actions.runs.run_attempt_label": "Run attempt #%[1]s (%[2]s)",
@@ -512,5 +555,6 @@
"editor.toggle_case": "Toggle case sensitivity",
"editor.toggle_regex": "Toggle using regular expressions",
"editor.toggle_whole_word": "Toggle matching whole words",
+ "form.RunnerName": "Name",
"meta.last_line": "Thank you for translating Forgejo! This line isn't seen by the users but it serves other purposes in the translation management. You can place a fun fact in the translation instead of translating it."
}
diff --git a/routers/web/repo/setting/runners.go b/routers/web/repo/setting/runners.go
index 32c8667825..ab3ec32c4a 100644
--- a/routers/web/repo/setting/runners.go
+++ b/routers/web/repo/setting/runners.go
@@ -5,7 +5,7 @@ package setting
import (
"errors"
- "net/http"
+ "fmt"
"net/url"
actions_model "forgejo.org/models/actions"
@@ -18,88 +18,109 @@ import (
)
const (
- // TODO: Separate secrets from runners when layout is ready
- tplRepoRunners base.TplName = "repo/settings/actions"
- tplOrgRunners base.TplName = "org/settings/actions"
- tplAdminRunners base.TplName = "admin/actions"
- tplUserRunners base.TplName = "user/settings/actions"
- tplRepoRunnerEdit base.TplName = "repo/settings/runner_edit"
- tplOrgRunnerEdit base.TplName = "org/settings/runners_edit"
- tplAdminRunnerEdit base.TplName = "admin/runners/edit"
- tplUserRunnerEdit base.TplName = "user/settings/runner_edit"
+ tplAdminRunnerCreate base.TplName = "admin/runners/create"
+ tplAdminRunnerDetails base.TplName = "admin/runners/details"
+ tplAdminRunnerEdit base.TplName = "admin/runners/edit"
+ tplAdminRunnerSetup base.TplName = "admin/runners/setup"
+ tplAdminRunners base.TplName = "admin/actions"
+ tplOrgRunnerCreate base.TplName = "org/settings/runners_create"
+ tplOrgRunnerDetails base.TplName = "org/settings/runners_details"
+ tplOrgRunnerEdit base.TplName = "org/settings/runners_edit"
+ tplOrgRunnerSetup base.TplName = "org/settings/runners_setup"
+ tplOrgRunners base.TplName = "org/settings/actions"
+ tplRepoRunnerCreate base.TplName = "repo/settings/runner_create"
+ tplRepoRunnerDetails base.TplName = "repo/settings/runner_details"
+ tplRepoRunnerEdit base.TplName = "repo/settings/runner_edit"
+ tplRepoRunnerSetup base.TplName = "repo/settings/runner_setup"
+ tplRepoRunners base.TplName = "repo/settings/actions"
+ tplUserRunnerCreate base.TplName = "user/settings/runner_create"
+ tplUserRunnerDetails base.TplName = "user/settings/runner_details"
+ tplUserRunnerEdit base.TplName = "user/settings/runner_edit"
+ tplUserRunnerSetup base.TplName = "user/settings/runner_setup"
+ tplUserRunners base.TplName = "user/settings/actions"
)
type runnersCtx struct {
- OwnerID int64
- RepoID int64
- IsRepo bool
- IsOrg bool
- IsAdmin bool
- IsUser bool
- RunnersTemplate base.TplName
- RunnerEditTemplate base.TplName
- RedirectLink string
+ OwnerID int64
+ RepoID int64
+ IsRepo bool
+ IsOrg bool
+ IsAdmin bool
+ IsUser bool
+ RunnerCreateTemplate base.TplName
+ RunnerDetailsTemplate base.TplName
+ RunnerEditTemplate base.TplName
+ RunnerSetupTemplate base.TplName
+ RunnersTemplate base.TplName
+ RedirectLink string
}
func getRunnersCtx(ctx *context.Context) (*runnersCtx, error) {
if ctx.Data["PageIsRepoSettings"] == true {
return &runnersCtx{
- RepoID: ctx.Repo.Repository.ID,
- OwnerID: 0,
- IsRepo: true,
- RunnersTemplate: tplRepoRunners,
- RunnerEditTemplate: tplRepoRunnerEdit,
- RedirectLink: ctx.Repo.RepoLink + "/settings/actions/runners/",
+ RepoID: ctx.Repo.Repository.ID,
+ OwnerID: 0,
+ IsRepo: true,
+ RunnerCreateTemplate: tplRepoRunnerCreate,
+ RunnerDetailsTemplate: tplRepoRunnerDetails,
+ RunnerEditTemplate: tplRepoRunnerEdit,
+ RunnerSetupTemplate: tplRepoRunnerSetup,
+ RunnersTemplate: tplRepoRunners,
+ RedirectLink: ctx.Repo.RepoLink + "/settings/actions/runners/",
}, nil
}
if ctx.Data["PageIsOrgSettings"] == true {
err := shared_user.LoadHeaderCount(ctx)
if err != nil {
- ctx.ServerError("LoadHeaderCount", err)
- return nil, nil
+ return nil, fmt.Errorf("could not load project and package counts: %w", err)
}
return &runnersCtx{
- RepoID: 0,
- OwnerID: ctx.Org.Organization.ID,
- IsOrg: true,
- RunnersTemplate: tplOrgRunners,
- RunnerEditTemplate: tplOrgRunnerEdit,
- RedirectLink: ctx.Org.OrgLink + "/settings/actions/runners/",
+ RepoID: 0,
+ OwnerID: ctx.Org.Organization.ID,
+ IsOrg: true,
+ RunnerCreateTemplate: tplOrgRunnerCreate,
+ RunnerDetailsTemplate: tplOrgRunnerDetails,
+ RunnerEditTemplate: tplOrgRunnerEdit,
+ RunnerSetupTemplate: tplOrgRunnerSetup,
+ RunnersTemplate: tplOrgRunners,
+ RedirectLink: ctx.Org.OrgLink + "/settings/actions/runners/",
}, nil
}
if ctx.Data["PageIsAdmin"] == true {
return &runnersCtx{
- RepoID: 0,
- OwnerID: 0,
- IsAdmin: true,
- RunnersTemplate: tplAdminRunners,
- RunnerEditTemplate: tplAdminRunnerEdit,
- RedirectLink: setting.AppSubURL + "/admin/actions/runners/",
+ RepoID: 0,
+ OwnerID: 0,
+ IsAdmin: true,
+ RunnerCreateTemplate: tplAdminRunnerCreate,
+ RunnerDetailsTemplate: tplAdminRunnerDetails,
+ RunnerEditTemplate: tplAdminRunnerEdit,
+ RunnerSetupTemplate: tplAdminRunnerSetup,
+ RunnersTemplate: tplAdminRunners,
+ RedirectLink: setting.AppSubURL + "/admin/actions/runners/",
}, nil
}
if ctx.Data["PageIsUserSettings"] == true {
return &runnersCtx{
- OwnerID: ctx.Doer.ID,
- RepoID: 0,
- IsUser: true,
- RunnersTemplate: tplUserRunners,
- RunnerEditTemplate: tplUserRunnerEdit,
- RedirectLink: setting.AppSubURL + "/user/settings/actions/runners/",
+ OwnerID: ctx.Doer.ID,
+ RepoID: 0,
+ IsUser: true,
+ RunnerCreateTemplate: tplUserRunnerCreate,
+ RunnerDetailsTemplate: tplUserRunnerDetails,
+ RunnerEditTemplate: tplUserRunnerEdit,
+ RunnerSetupTemplate: tplUserRunnerSetup,
+ RunnersTemplate: tplUserRunners,
+ RedirectLink: setting.AppSubURL + "/user/settings/actions/runners/",
}, nil
}
return nil, errors.New("unable to set Runners context")
}
-// Runners render settings/actions/runners page for repo level
+// Runners renders the list of all available runners.
func Runners(ctx *context.Context) {
- ctx.Data["PageIsSharedSettingsRunners"] = true
- ctx.Data["Title"] = ctx.Tr("actions.actions")
- ctx.Data["PageType"] = "runners"
-
rCtx, err := getRunnersCtx(ctx)
if err != nil {
ctx.ServerError("getRunnersCtx", err)
@@ -126,60 +147,114 @@ func Runners(ctx *context.Context) {
opts.OwnerID = rCtx.OwnerID
opts.WithAvailable = true
}
- actions_shared.RunnersList(ctx, opts)
- ctx.HTML(http.StatusOK, rCtx.RunnersTemplate)
+ ctx.Data["RunnersListLink"] = rCtx.RedirectLink
+
+ actions_shared.RunnersList(ctx, rCtx.RunnersTemplate, opts)
}
-// RunnersEdit renders runner edit page for repository level
-func RunnersEdit(ctx *context.Context) {
- ctx.Data["PageIsSharedSettingsRunners"] = true
- ctx.Data["Title"] = ctx.Tr("actions.runners.edit_runner")
+// RunnersDetails renders a read-only view of the most important properties of a runner. It is accessible to every user
+// that can use that particular runner.
+func RunnersDetails(ctx *context.Context) {
rCtx, err := getRunnersCtx(ctx)
if err != nil {
ctx.ServerError("getRunnersCtx", err)
return
}
+ runnerID := ctx.ParamsInt64(":runnerid")
page := ctx.FormInt("page")
if page <= 1 {
page = 1
}
- actions_shared.RunnerDetails(ctx, page,
- ctx.ParamsInt64(":runnerid"), rCtx.OwnerID, rCtx.RepoID,
- )
- ctx.HTML(http.StatusOK, rCtx.RunnerEditTemplate)
+ ctx.Data["RunnersListLink"] = rCtx.RedirectLink
+
+ actions_shared.RunnerDetails(ctx, runnerID, rCtx.OwnerID, rCtx.RepoID, rCtx.RunnerDetailsTemplate, page)
}
+// RunnersCreate renders the form for creating a new runner.
+func RunnersCreate(ctx *context.Context) {
+ rCtx, err := getRunnersCtx(ctx)
+ if err != nil {
+ ctx.ServerError("getRunnersCtx", err)
+ return
+ }
+
+ ctx.Data["RunnersListLink"] = rCtx.RedirectLink
+
+ actions_shared.RunnerCreate(ctx, rCtx.RunnerCreateTemplate)
+}
+
+// RunnersCreatePost handles the form submitted by RunnersCreate.
+func RunnersCreatePost(ctx *context.Context) {
+ rCtx, err := getRunnersCtx(ctx)
+ if err != nil {
+ ctx.ServerError("getRunnersCtx", err)
+ return
+ }
+
+ ctx.Data["RunnersListLink"] = rCtx.RedirectLink
+
+ actions_shared.RunnerCreatePost(ctx, rCtx.OwnerID, rCtx.RepoID, rCtx.RunnerCreateTemplate, rCtx.RunnerSetupTemplate)
+}
+
+// RunnersEdit renders the form for changing an existing runner.
+func RunnersEdit(ctx *context.Context) {
+ rCtx, err := getRunnersCtx(ctx)
+ if err != nil {
+ ctx.ServerError("getRunnersCtx", err)
+ return
+ }
+
+ ctx.Data["RunnersListLink"] = rCtx.RedirectLink
+
+ actions_shared.RunnerEdit(ctx, ctx.ParamsInt64(":runnerid"), rCtx.OwnerID, rCtx.RepoID, rCtx.RunnerEditTemplate)
+}
+
+// RunnersEditPost handles the form submitted by RunnersEdit.
func RunnersEditPost(ctx *context.Context) {
rCtx, err := getRunnersCtx(ctx)
if err != nil {
ctx.ServerError("getRunnersCtx", err)
return
}
- actions_shared.RunnerDetailsEditPost(ctx, ctx.ParamsInt64(":runnerid"),
- rCtx.OwnerID, rCtx.RepoID,
- rCtx.RedirectLink+url.PathEscape(ctx.Params(":runnerid")))
+
+ ctx.Data["RunnersListLink"] = rCtx.RedirectLink
+
+ runnerID := ctx.ParamsInt64(":runnerid")
+ redirectURL := rCtx.RedirectLink + url.PathEscape(ctx.Params(":runnerid"))
+ actions_shared.RunnerEditPost(ctx, runnerID, rCtx.OwnerID, rCtx.RepoID, rCtx.RunnerEditTemplate,
+ rCtx.RunnerSetupTemplate, redirectURL)
}
+// ResetRunnerRegistrationToken handles the request to reset the runner registration token.
func ResetRunnerRegistrationToken(ctx *context.Context) {
rCtx, err := getRunnersCtx(ctx)
if err != nil {
ctx.ServerError("getRunnersCtx", err)
return
}
+
+ ctx.Data["RunnersListLink"] = rCtx.RedirectLink
+
actions_shared.RunnerResetRegistrationToken(ctx, rCtx.OwnerID, rCtx.RepoID, rCtx.RedirectLink)
}
-// RunnerDeletePost response for deleting runner
+// RunnerDeletePost handles the request to delete a runner.
func RunnerDeletePost(ctx *context.Context) {
rCtx, err := getRunnersCtx(ctx)
if err != nil {
ctx.ServerError("getRunnersCtx", err)
return
}
- actions_shared.RunnerDeletePost(ctx, ctx.ParamsInt64(":runnerid"), rCtx.OwnerID, rCtx.RepoID, rCtx.RedirectLink, rCtx.RedirectLink+url.PathEscape(ctx.Params(":runnerid")))
+
+ ctx.Data["RunnersListLink"] = rCtx.RedirectLink
+
+ runnerID := ctx.ParamsInt64(":runnerid")
+ successRedirectURL := rCtx.RedirectLink
+ failureRedirectURL := rCtx.RedirectLink
+ actions_shared.RunnerDeletePost(ctx, runnerID, rCtx.OwnerID, rCtx.RepoID, successRedirectURL, failureRedirectURL)
}
func RedirectToDefaultSetting(ctx *context.Context) {
diff --git a/routers/web/shared/actions/runners.go b/routers/web/shared/actions/runners.go
index 9d0ad3b0cd..ab52faf9f5 100644
--- a/routers/web/shared/actions/runners.go
+++ b/routers/web/shared/actions/runners.go
@@ -5,19 +5,24 @@ package actions
import (
"errors"
+ "net/http"
actions_model "forgejo.org/models/actions"
"forgejo.org/models/db"
+ "forgejo.org/modules/base"
"forgejo.org/modules/log"
"forgejo.org/modules/optional"
+ "forgejo.org/modules/setting"
"forgejo.org/modules/util"
"forgejo.org/modules/web"
"forgejo.org/services/context"
"forgejo.org/services/forms"
+
+ gouuid "github.com/google/uuid"
)
-// RunnersList prepares data for runners list
-func RunnersList(ctx *context.Context, opts actions_model.FindRunnerOptions) {
+// RunnersList renders the list of runners.
+func RunnersList(ctx *context.Context, template base.TplName, opts actions_model.FindRunnerOptions) {
runners, count, err := db.FindAndCount[actions_model.ActionRunner](ctx, opts)
if err != nil {
ctx.ServerError("CountRunners", err)
@@ -52,6 +57,9 @@ func RunnersList(ctx *context.Context, opts actions_model.FindRunnerOptions) {
return
}
+ ctx.Data["PageIsSharedSettingsRunners"] = true
+ ctx.Data["Title"] = ctx.Tr("actions.actions")
+ ctx.Data["PageType"] = "runners"
ctx.Data["Keyword"] = opts.Filter
ctx.Data["Runners"] = runners
ctx.Data["Total"] = count
@@ -63,26 +71,24 @@ func RunnersList(ctx *context.Context, opts actions_model.FindRunnerOptions) {
pager := context.NewPagination(int(count), opts.PageSize, opts.Page, 5)
ctx.Data["Page"] = pager
+ ctx.HTML(http.StatusOK, template)
}
-// RunnerDetails prepares data for runners edit page
-func RunnerDetails(ctx *context.Context, page int, runnerID, ownerID, repoID int64) {
- runner, err := actions_model.GetRunnerByID(ctx, runnerID)
- if err != nil {
- ctx.ServerError("GetRunnerByID", err)
+// RunnerDetails displays detail information about each runner. The page is purely informational and visible to everyone
+// who is allowed to use a runner.
+func RunnerDetails(ctx *context.Context, runnerID, ownerID, repoID int64, template base.TplName, page int) {
+ runner, err := actions_model.GetAvailableRunnerByID(ctx, runnerID, ownerID, repoID)
+ if errors.Is(err, util.ErrNotExist) {
+ ctx.NotFound("GetAvailableRunnerByID", err)
+ return
+ } else if err != nil {
+ ctx.ServerError("GetAvailableRunnerByID", err)
return
}
if err := runner.LoadAttributes(ctx); err != nil {
ctx.ServerError("LoadAttributes", err)
return
}
- if !runner.Editable(ownerID, repoID) {
- err = errors.New("no permission to edit this runner")
- ctx.NotFound("RunnerDetails", err)
- return
- }
-
- ctx.Data["Runner"] = runner
opts := actions_model.FindTaskOptions{
ListOptions: db.ListOptions{
@@ -90,6 +96,8 @@ func RunnerDetails(ctx *context.Context, page int, runnerID, ownerID, repoID int
PageSize: 30,
},
RunnerID: runner.ID,
+ OwnerID: ownerID,
+ RepoID: repoID,
}
tasks, count, err := db.FindAndCount[actions_model.ActionTask](ctx, opts)
@@ -103,42 +111,147 @@ func RunnerDetails(ctx *context.Context, page int, runnerID, ownerID, repoID int
return
}
+ ctx.Data["PageIsSharedSettingsRunners"] = true
+ ctx.Data["RunnerOwnerID"] = ownerID
+ ctx.Data["RunnerRepoID"] = repoID
+ ctx.Data["Title"] = ctx.Tr("actions.runners.runner_details.page_title", runner.Name)
+ ctx.Data["Runner"] = runner
ctx.Data["Tasks"] = tasks
pager := context.NewPagination(int(count), opts.PageSize, opts.Page, 5)
ctx.Data["Page"] = pager
+ ctx.HTML(http.StatusOK, template)
}
-// RunnerDetailsEditPost response for edit runner details
-func RunnerDetailsEditPost(ctx *context.Context, runnerID, ownerID, repoID int64, redirectTo string) {
- runner, err := actions_model.GetRunnerByID(ctx, runnerID)
+// RunnerCreate displays a form for creating a new runner.
+func RunnerCreate(ctx *context.Context, template base.TplName) {
+ ctx.Data["PageIsSharedSettingsRunners"] = true
+ ctx.Data["Title"] = ctx.Tr("actions.runners.create_runner.page_title")
+ ctx.HTML(http.StatusOK, template)
+}
+
+// RunnerCreatePost handles the form submitted by RunnerCreate.
+func RunnerCreatePost(ctx *context.Context, ownerID, repoID int64, template, successTemplate base.TplName) {
+ form := web.GetForm(ctx).(*forms.CreateRunnerForm)
+
+ runner := actions_model.ActionRunner{
+ UUID: gouuid.New().String(),
+ Name: form.RunnerName,
+ OwnerID: ownerID,
+ RepoID: repoID,
+ Description: form.RunnerDescription,
+ Ephemeral: false,
+ }
+ runner.GenerateToken()
+
+ ctx.Data["PageIsSharedSettingsRunners"] = true
+ ctx.Data["Title"] = ctx.Tr("actions.runners.runner_setup.page_title", runner.Name)
+ ctx.Data["AppURL"] = setting.AppURL
+ ctx.Data["Runner"] = runner
+ ctx.Data["RunnerOwnerID"] = ownerID
+ ctx.Data["RunnerRepoID"] = repoID
+
+ if ctx.HasError() {
+ ctx.HTML(http.StatusOK, template)
+ return
+ }
+
+ err := actions_model.CreateRunner(ctx, &runner)
if err != nil {
- log.Warn("RunnerDetailsEditPost.GetRunnerByID failed: %v, url: %s", err, ctx.Req.URL)
- ctx.ServerError("RunnerDetailsEditPost.GetRunnerByID", err)
+ ctx.ServerError("CreateRunner", err)
+ return
+ }
+
+ ctx.HTML(http.StatusOK, successTemplate)
+}
+
+// RunnerEdit displays a form to modify the given runner.
+func RunnerEdit(ctx *context.Context, runnerID, ownerID, repoID int64, template base.TplName) {
+ runner, err := actions_model.GetAvailableRunnerByID(ctx, runnerID, ownerID, repoID)
+ if errors.Is(err, util.ErrNotExist) {
+ ctx.NotFound("GetAvailableRunnerByID", err)
+ return
+ } else if err != nil {
+ ctx.ServerError("GetAvailableRunnerByID", err)
+ return
+ }
+ if err := runner.LoadAttributes(ctx); err != nil {
+ ctx.ServerError("LoadAttributes", err)
return
}
if !runner.Editable(ownerID, repoID) {
- ctx.NotFound("RunnerDetailsEditPost.Editable", util.NewPermissionDeniedErrorf("no permission to edit this runner"))
+ err = errors.New("no permission to edit this runner")
+ ctx.NotFound("RunnerDetails", err)
return
}
- form := web.GetForm(ctx).(*forms.EditRunnerForm)
- runner.Description = form.Description
+ ctx.Data["PageIsSharedSettingsRunners"] = true
+ ctx.Data["Title"] = ctx.Tr("actions.runners.edit_runner.page_title", runner.Name)
+ ctx.Data["Runner"] = runner
+ ctx.Data["RunnerOwnerID"] = ownerID
+ ctx.Data["RunnerRepoID"] = repoID
+ ctx.HTML(http.StatusOK, template)
+}
- err = actions_model.UpdateRunner(ctx, runner, "description")
+// RunnerEditPost handles the form submitted by RunnerEdit.
+func RunnerEditPost(ctx *context.Context, runnerID, ownerID, repoID int64, template, successTemplate base.TplName, redirectTo string) {
+ runner, err := actions_model.GetAvailableRunnerByID(ctx, runnerID, ownerID, repoID)
+ if errors.Is(err, util.ErrNotExist) {
+ ctx.NotFound("GetAvailableRunnerByID", err)
+ return
+ } else if err != nil {
+ ctx.ServerError("GetAvailableRunnerByID", err)
+ return
+ }
+ if !runner.Editable(ownerID, repoID) {
+ ctx.NotFound("RunnerEditPost.Editable", util.NewPermissionDeniedErrorf("no permission to edit this runner"))
+ return
+ }
+
+ ctx.Data["PageIsSharedSettingsRunners"] = true
+ ctx.Data["Title"] = ctx.Tr("actions.runners.runner_setup.page_title", runner.Name)
+ ctx.Data["AppURL"] = setting.AppURL
+ ctx.Data["Runner"] = runner
+ ctx.Data["RunnerOwnerID"] = ownerID
+ ctx.Data["RunnerRepoID"] = repoID
+
+ form := web.GetForm(ctx).(*forms.EditRunnerForm)
+ runner.Name = form.RunnerName
+ runner.Description = form.RunnerDescription
+
+ if ctx.HasError() {
+ ctx.HTML(http.StatusOK, template)
+ return
+ }
+
+ if !form.RegenerateToken {
+ err = actions_model.UpdateRunner(ctx, runner, "name", "description")
+ if err != nil {
+ log.Warn("RunnerEditPost.UpdateRunner failed: %v, url: %s", err, ctx.Req.URL)
+ ctx.Flash.Warning(ctx.Tr("actions.runners.update_runner.failed"))
+ ctx.Redirect(redirectTo)
+ return
+ }
+
+ log.Debug("RunnerEditPost success: %s", ctx.Req.URL)
+
+ ctx.Flash.Success(ctx.Tr("actions.runners.update_runner.success"))
+ ctx.Redirect(redirectTo)
+ return
+ }
+
+ runner.GenerateToken()
+ err = actions_model.UpdateRunner(ctx, runner, "name", "description", "token_hash", "token_salt")
if err != nil {
- log.Warn("RunnerDetailsEditPost.UpdateRunner failed: %v, url: %s", err, ctx.Req.URL)
+ log.Warn("RunnerEditPost.UpdateRunner failed: %v, url: %s", err, ctx.Req.URL)
ctx.Flash.Warning(ctx.Tr("actions.runners.update_runner.failed"))
ctx.Redirect(redirectTo)
return
}
- log.Debug("RunnerDetailsEditPost success: %s", ctx.Req.URL)
-
- ctx.Flash.Success(ctx.Tr("actions.runners.update_runner.success"))
- ctx.Redirect(redirectTo)
+ ctx.HTML(http.StatusOK, successTemplate)
}
-// RunnerResetRegistrationToken reset registration token
+// RunnerResetRegistrationToken resets the runner registration token.
func RunnerResetRegistrationToken(ctx *context.Context, ownerID, repoID int64, redirectTo string) {
optOwnerID := optional.None[int64]()
if ownerID != 0 {
@@ -159,10 +272,8 @@ func RunnerResetRegistrationToken(ctx *context.Context, ownerID, repoID int64, r
ctx.Redirect(redirectTo)
}
-// RunnerDeletePost response for deleting a runner
-func RunnerDeletePost(ctx *context.Context, runnerID, ownerID, repoID int64,
- successRedirectTo, failedRedirectTo string,
-) {
+// RunnerDeletePost handles the request for deleting a particular runner.
+func RunnerDeletePost(ctx *context.Context, runnerID, ownerID, repoID int64, successRedirectTo, failedRedirectTo string) {
runner, err := actions_model.GetRunnerByID(ctx, runnerID)
if err != nil {
ctx.ServerError("GetRunnerByID", err)
@@ -176,6 +287,7 @@ func RunnerDeletePost(ctx *context.Context, runnerID, ownerID, repoID int64,
if err := actions_model.DeleteRunner(ctx, runner); err != nil {
log.Warn("DeleteRunnerPost.UpdateRunner failed: %v, url: %s", err, ctx.Req.URL)
+
ctx.Flash.Warning(ctx.Tr("actions.runners.delete_runner.failed"))
ctx.JSONRedirect(failedRedirectTo)
diff --git a/routers/web/shared/actions/runners_test.go b/routers/web/shared/actions/runners_test.go
index ad75d34ee6..9426bbdf08 100644
--- a/routers/web/shared/actions/runners_test.go
+++ b/routers/web/shared/actions/runners_test.go
@@ -25,14 +25,15 @@ func TestRunnerDetails(t *testing.T) {
t.Run("permission denied", func(t *testing.T) {
ctx, resp := contexttest.MockContext(t, "/admin/actions/runners")
- RunnerDetails(ctx, 1, runner.ID, user.ID, 0)
- assert.Equal(t, http.StatusNotFound, resp.Code)
+ RunnerDetails(ctx, runner.ID, user.ID, 0, "admin/runners/details", 1)
+ assert.Equal(t, http.StatusOK, resp.Code)
+ assert.Empty(t, ctx.GetData()["Tasks"])
})
t.Run("first page", func(t *testing.T) {
ctx, resp := contexttest.MockContext(t, "/admin/actions/runners")
page := 1
- RunnerDetails(ctx, page, runner.ID, 0, 0)
+ RunnerDetails(ctx, runner.ID, 0, 0, "admin/runners/details", page)
require.Equal(t, http.StatusOK, resp.Code)
assert.Len(t, ctx.GetData()["Tasks"], 30)
})
@@ -40,7 +41,7 @@ func TestRunnerDetails(t *testing.T) {
t.Run("second and last page", func(t *testing.T) {
ctx, resp := contexttest.MockContext(t, "/admin/actions/runners")
page := 2
- RunnerDetails(ctx, page, runner.ID, 0, 0)
+ RunnerDetails(ctx, runner.ID, 0, 0, "admin/runners/details", page)
require.Equal(t, http.StatusOK, resp.Code)
assert.Len(t, ctx.GetData()["Tasks"], 10)
})
diff --git a/routers/web/web.go b/routers/web/web.go
index 6cddc1d0b0..ee3a515dff 100644
--- a/routers/web/web.go
+++ b/routers/web/web.go
@@ -461,7 +461,12 @@ func registerRoutes(m *web.Route) {
addSettingsRunnersRoutes := func() {
m.Group("/runners", func() {
m.Get("", repo_setting.Runners)
- m.Combo("/{runnerid}").Get(repo_setting.RunnersEdit).
+ m.Combo("/new").
+ Get(repo_setting.RunnersCreate).
+ Post(web.Bind(forms.CreateRunnerForm{}), repo_setting.RunnersCreatePost)
+ m.Get("/{runnerid}", repo_setting.RunnersDetails)
+ m.Combo("/{runnerid}/edit").
+ Get(repo_setting.RunnersEdit).
Post(web.Bind(forms.EditRunnerForm{}), repo_setting.RunnersEditPost)
m.Post("/{runnerid}/delete", repo_setting.RunnerDeletePost)
m.Get("/reset_registration_token", repo_setting.ResetRunnerRegistrationToken)
diff --git a/services/forms/runner.go b/services/forms/runner.go
index fcf6c5a694..319fffcee1 100644
--- a/services/forms/runner.go
+++ b/services/forms/runner.go
@@ -12,12 +12,26 @@ import (
"code.forgejo.org/go-chi/binding"
)
-// EditRunnerForm form for admin to create runner
-type EditRunnerForm struct {
- Description string
+// CreateRunnerForm needs to be filled in by the user to create a new runner.
+type CreateRunnerForm struct {
+ RunnerName string `binding:"Required;MaxSize(255)"`
+ RunnerDescription string
}
-// Validate validates form fields
+// Validate validates the submitted form.
+func (f *CreateRunnerForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
+ ctx := context.GetValidateContext(req)
+ return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
+}
+
+// EditRunnerForm can be filled in by the user to change an existing runner.
+type EditRunnerForm struct {
+ RunnerName string `binding:"Required;MaxSize(255)"`
+ RunnerDescription string
+ RegenerateToken bool
+}
+
+// Validate validates the submitted form.
func (f *EditRunnerForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
ctx := context.GetValidateContext(req)
return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
diff --git a/templates/admin/runners/create.tmpl b/templates/admin/runners/create.tmpl
new file mode 100644
index 0000000000..5d3bc739ac
--- /dev/null
+++ b/templates/admin/runners/create.tmpl
@@ -0,0 +1,5 @@
+{{template "admin/layout_head" (dict "ctxData" . "pageClass" "admin runners")}}
+{{ctx.Locale.Tr "actions.runners.runner_details.labels_note"}}
+| {{ctx.Locale.Tr "actions.runners.task_list.run"}} | +{{ctx.Locale.Tr "actions.runners.task_list.status"}} | +{{ctx.Locale.Tr "actions.runners.task_list.repository"}} | +{{ctx.Locale.Tr "actions.runners.task_list.commit"}} | +{{ctx.Locale.Tr "actions.runners.task_list.done_at"}} | +
|---|---|---|---|---|
| {{.ID}} | +{{.Status.LocaleString ctx.Locale}} | +{{.GetRepoName}} | ++ {{ShortSha .CommitSHA}} + | +{{if .IsStopped}} + {{DateUtils.TimeSince .Stopped}} + {{else}}-{{end}} | +
| {{ctx.Locale.Tr "actions.runners.task_list.no_tasks"}} | +||||