mirror of
https://gitea.com/gitea/act_runner.git
synced 2026-05-02 17:00:26 +08:00
13dc9386fe
## Consumer-facing breaking changes
- **Go module path**: `gitea.com/gitea/act_runner` → `gitea.com/gitea/runner`. Anything importing `act/...` or `internal/...` packages (notably Gitea itself) must update imports.
- **Binary name**: `act_runner` → `gitea-runner`. Wrapper scripts, systemd units, init scripts, and documentation referencing the binary by `act_runner` will break.
- **Docker image**: `gitea/act_runner` → `gitea/runner` (incl. `*-dind-rootless` variants). Users pulling `gitea/act_runner:nightly` etc. will get stale images. Note: the image name is `gitea/runner`, not `gitea/gitea-runner`.
- **Release artifact paths**: S3 directory `act_runner/{{.Version}}` → `gitea-runner/{{.Version}}`, and artifact filenames change with the new project name. Existing download URLs break.
- **Metrics namespace**: changed from `act_runner` to `gitea_runner` (e.g. `act_runner_jobs_total` → `gitea_runner_jobs_total`); existing monitors/dashboards must be updated.
- **ldflags version path**: `gitea.com/gitea/act_runner/internal/pkg/ver.version` → `gitea.com/gitea/runner/internal/pkg/ver.version`. Affects anyone building with custom ldflags.
- **Kubernetes example resource names**: `act-runner` / `act-runner-vol` → `runner` / `runner-vol`. Users who copied the manifests verbatim will see resource churn on apply.
- **s6 service name**: `scripts/s6/act_runner/` → `scripts/s6/gitea-runner/` (image-internal; only matters for downstream image overrides).
Unchanged: YAML config field names, env vars (`GITEA_*`), CLI flags/subcommands, registration file format.
---------
Co-authored-by: silverwind <me@silverwind.io>
Reviewed-on: https://gitea.com/gitea/runner/pulls/850
Reviewed-by: Zettat123 <39446+zettat123@noreply.gitea.com>
Reviewed-by: silverwind <2021+silverwind@noreply.gitea.com>
Reviewed-by: Nicolas <bircni@icloud.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-committed-by: Lunny Xiao <xiaolunwen@gmail.com>
88 lines
2.8 KiB
Go
88 lines
2.8 KiB
Go
// Copyright 2022 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package cmd
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"os"
|
|
|
|
"gitea.com/gitea/runner/internal/pkg/config"
|
|
"gitea.com/gitea/runner/internal/pkg/ver"
|
|
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
func Execute(ctx context.Context) {
|
|
// ./gitea-runner
|
|
rootCmd := &cobra.Command{
|
|
Use: "gitea-runner",
|
|
Short: "Gitea Runner",
|
|
Version: ver.Version(),
|
|
SilenceUsage: true,
|
|
}
|
|
configFile := ""
|
|
rootCmd.PersistentFlags().StringVarP(&configFile, "config", "c", "", "Config file path")
|
|
|
|
// ./gitea-runner register
|
|
var regArgs registerArgs
|
|
registerCmd := &cobra.Command{
|
|
Use: "register",
|
|
Short: "Register a runner to the server",
|
|
Args: cobra.MaximumNArgs(0),
|
|
RunE: runRegister(ctx, ®Args, &configFile), // must use a pointer to regArgs
|
|
}
|
|
registerCmd.Flags().BoolVar(®Args.NoInteractive, "no-interactive", false, "Disable interactive mode")
|
|
registerCmd.Flags().StringVar(®Args.InstanceAddr, "instance", "", "Gitea instance address")
|
|
registerCmd.Flags().StringVar(®Args.Token, "token", "", "Runner token")
|
|
registerCmd.Flags().StringVar(®Args.RunnerName, "name", "", "Runner name")
|
|
registerCmd.Flags().StringVar(®Args.Labels, "labels", "", "Runner tags, comma separated")
|
|
registerCmd.Flags().BoolVar(®Args.Ephemeral, "ephemeral", false, "Configure the runner to be ephemeral and only ever be able to pick a single job (stricter than --once)")
|
|
rootCmd.AddCommand(registerCmd)
|
|
|
|
// ./gitea-runner daemon
|
|
var daemArgs daemonArgs
|
|
daemonCmd := &cobra.Command{
|
|
Use: "daemon",
|
|
Short: "Run as a runner daemon",
|
|
Args: cobra.MaximumNArgs(0),
|
|
RunE: runDaemon(ctx, &daemArgs, &configFile),
|
|
}
|
|
daemonCmd.Flags().BoolVar(&daemArgs.Once, "once", false, "Run one job then exit")
|
|
rootCmd.AddCommand(daemonCmd)
|
|
|
|
// ./gitea-runner exec
|
|
rootCmd.AddCommand(loadExecCmd(ctx))
|
|
|
|
// ./gitea-runner config
|
|
rootCmd.AddCommand(&cobra.Command{
|
|
Use: "generate-config",
|
|
Short: "Generate an example config file",
|
|
Args: cobra.MaximumNArgs(0),
|
|
Run: func(_ *cobra.Command, _ []string) {
|
|
fmt.Printf("%s", config.Example)
|
|
},
|
|
})
|
|
|
|
// ./gitea-runner cache-server
|
|
var cacheArgs cacheServerArgs
|
|
cacheCmd := &cobra.Command{
|
|
Use: "cache-server",
|
|
Short: "Start a cache server for the cache action",
|
|
Args: cobra.MaximumNArgs(0),
|
|
RunE: runCacheServer(&configFile, &cacheArgs),
|
|
}
|
|
cacheCmd.Flags().StringVarP(&cacheArgs.Dir, "dir", "d", "", "Cache directory")
|
|
cacheCmd.Flags().StringVarP(&cacheArgs.Host, "host", "s", "", "Host of the cache server")
|
|
cacheCmd.Flags().Uint16VarP(&cacheArgs.Port, "port", "p", 0, "Port of the cache server")
|
|
rootCmd.AddCommand(cacheCmd)
|
|
|
|
// hide completion command
|
|
rootCmd.CompletionOptions.HiddenDefaultCmd = true
|
|
|
|
if err := rootCmd.Execute(); err != nil {
|
|
os.Exit(1)
|
|
}
|
|
}
|