切换存储方式

Author: ExplodingDragon

.github/workflows/go-test.yml

@@ -28,7 +28,7 @@ jobs:
         run: go mod download
 
       - name: Run tests with coverage
-        run: go test -v -coverprofile=coverage.txt ./...
+        run: make test lint
 
       - uses: codecov/codecov-action@v5
         with:

.gitignore

@@ -63,4 +63,5 @@ fabric.properties
 config-local.yaml
 gitea-pages
 *.zip
-dist/
+dist/
+coverage.txt

.golangci.yml

@@ -0,0 +1,183 @@
+# fork from gitea https://github.com/go-gitea/gitea/blob/main/.golangci.yml
+version: "2"
+output:
+  sort-order:
+    - file
+linters:
+  default: none
+  enable:
+    - bidichk
+    - depguard
+    - dupl
+    - errcheck
+    - forbidigo
+    - gocritic
+    - govet
+    - ineffassign
+    - mirror
+    - nakedret
+    - nolintlint
+    - perfsprint
+    - revive
+    - staticcheck
+    - testifylint
+    - unconvert
+    - unparam
+    - unused
+    - usestdlibvars
+    - usetesting
+    - wastedassign
+  settings:
+    depguard:
+      rules:
+        main:
+          deny:
+            - pkg: github.com/unknwon/com
+              desc: use gitea's util and replacements
+            - pkg: io/ioutil
+              desc: use os or io instead
+            - pkg: golang.org/x/exp
+              desc: it's experimental and unreliable
+            - pkg: code.gitea.io/gitea/modules/git/internal
+              desc: do not use the internal package, use AddXxx function instead
+            - pkg: gopkg.in/ini.v1
+              desc: do not use the ini package, use gitea's config system instead
+            - pkg: gitea.com/go-chi/cache
+              desc: do not use the go-chi cache package, use gitea's cache system
+    nolintlint:
+      allow-unused: false
+      require-explanation: true
+      require-specific: true
+    gocritic:
+      enabled-checks:
+        - equalFold
+      disabled-checks:
+        - ifElseChain
+        - singleCaseSwitch # Every time this occurred in the code, there was no other way.
+    revive:
+      severity: error
+      rules:
+        - name: atomic
+        - name: bare-return
+        - name: blank-imports
+        - name: constant-logical-expr
+        - name: context-as-argument
+        - name: context-keys-type
+        - name: dot-imports
+        - name: duplicated-imports
+        - name: empty-lines
+        - name: error-naming
+        - name: error-return
+        - name: error-strings
+        - name: errorf
+        - name: exported
+        - name: identical-branches
+        - name: if-return
+        - name: increment-decrement
+        - name: indent-error-flow
+        - name: modifies-value-receiver
+        - name: package-comments
+        - name: range
+        - name: receiver-naming
+        - name: redefines-builtin-id
+        - name: string-of-int
+        - name: superfluous-else
+        - name: time-naming
+        - name: unconditional-recursion
+        - name: unexported-return
+        - name: unreachable-code
+        - name: var-declaration
+        - name: var-naming
+          arguments:
+            - [] # AllowList - do not remove as args for the rule are positional and won't work without lists first
+            - [] # DenyList
+            - - skip-package-name-checks: true # supress errors from underscore in migration packages
+    staticcheck:
+      checks:
+        - all
+        - -ST1003
+        - -ST1005
+        - -QF1001
+        - -QF1006
+        - -QF1008
+    testifylint:
+      disable:
+        - go-require
+        - require-error
+    usetesting:
+      os-temp-dir: true
+  exclusions:
+    generated: lax
+    presets:
+      - comments
+      - common-false-positives
+      - legacy
+      - std-error-handling
+    rules:
+      - linters:
+          - dupl
+          - errcheck
+          - gocyclo
+          - gosec
+          - staticcheck
+          - unparam
+        path: _test\.go
+      - linters:
+          - dupl
+          - errcheck
+          - gocyclo
+          - gosec
+        path: models/migrations/v
+      - linters:
+          - forbidigo
+        path: cmd
+      - linters:
+          - dupl
+        text: (?i)webhook
+      - linters:
+          - gocritic
+        text: (?i)`ID' should not be capitalized
+      - linters:
+          - deadcode
+          - unused
+        text: (?i)swagger
+      - linters:
+          - staticcheck
+        text: (?i)argument x is overwritten before first use
+      - linters:
+          - gocritic
+        text: '(?i)commentFormatting: put a space between `//` and comment text'
+      - linters:
+          - gocritic
+        text: '(?i)exitAfterDefer:'
+    paths:
+      - node_modules
+      - .venv
+      - public
+      - web_src
+      - third_party$
+      - builtin$
+      - examples$
+issues:
+  max-issues-per-linter: 0
+  max-same-issues: 0
+formatters:
+  enable:
+    - gofmt
+    - gofumpt
+  settings:
+    gofumpt:
+      extra-rules: true
+  exclusions:
+    generated: lax
+    paths:
+      - node_modules
+      - .venv
+      - public
+      - web_src
+      - third_party$
+      - builtin$
+      - examples$
+
+run:
+  timeout: 10m

Makefile

@@ -35,7 +35,7 @@ debug: gitea-pages
 
 .PHONY: test
 test:
-	@go test -v ./...
+	@go test -v -coverprofile=coverage.txt ./...
 
 
 .PHONY: releases
@@ -44,3 +44,13 @@ releases:
 	make release GOOS=linux GOARCH=arm64 && \
 	make release GOOS=linux GOARCH=loong64 && \
 	make release GOOS=windows GOARCH=amd64
+
+.PHONY: lint
+lint:
+	@(test -f "$(GOPATH)/bin/golangci-lint" || go install github.com/golangci/golangci-lint/v2/cmd/[email protected]) && \
+	"$(GOPATH)/bin/golangci-lint" run -c .golangci.yml
+
+.PHONY: lint-fix
+lint-fix:
+	@(test -f "$(GOPATH)/bin/golangci-lint" || go install github.com/golangci/golangci-lint/v2/cmd/[email protected]) && \
+	"$(GOPATH)/bin/golangci-lint" run -c .golangci.yml --fix

README.md

@@ -10,7 +10,7 @@ This project focuses on functional implementation and does not consider any perf
 
 ## Get Started
 
-Install `go1.24` or later, along with the `Make` tool, and then execute the following command:
+Install `go1.25` or later, along with the `Make` tool, and then execute the following command:
 
 ```bash
 make gitea-pages

README_zh.md

@@ -10,7 +10,7 @@
 
 ## Get Started
 
-安装 `go1.24` 或更高版本，同时安装 `Make` 工具 ，然后执行如下命令:
+安装 `go1.25` 或更高版本，同时安装 `Make` 工具 ，然后执行如下命令:
 
 ```bash
 make gitea-pages

config.go

@@ -24,7 +24,7 @@ type Config struct {
 	Bind   string `yaml:"bind"`   // HTTP 绑定
 	Domain string `yaml:"domain"` // 基础域名
 
-	Config string `yaml:"config"` // 配置
+	Database ConfigDatabase `yaml:"database"` // 配置
 
 	Auth ConfigAuth `yaml:"auth"` // 后端认证配置
 
@@ -46,7 +46,7 @@ func (c *Config) NewPageServerOptions() (*pkg.ServerOptions, error) {
 	}
 	var err error
 
-	if c.Config == "" {
+	if c.Database.URL == "" {
 		return nil, errors.New("config is required")
 	}
 	if c.StaticDir != "" {
@@ -88,7 +88,7 @@ func (c *Config) NewPageServerOptions() (*pkg.ServerOptions, error) {
 	if err != nil {
 		return nil, errors.Wrap(err, "create cache")
 	}
-	alias, err := kv.NewKVFromURL(c.Config)
+	alias, err := kv.NewKVFromURL(c.Database.URL)
 	if err != nil {
 		return nil, errors.Wrapf(err, "failed to init alias config")
 	}
@@ -105,7 +105,7 @@ func (c *Config) NewPageServerOptions() (*pkg.ServerOptions, error) {
 		CacheBlob:           memoryCache,
 		CacheBlobTTL:        c.Cache.BlobTTL,
 		CacheBlobLimit:      uint64(c.Cache.BlobLimit),
-		HttpClient:          http.DefaultClient,
+		HTTPClient:          http.DefaultClient,
 		EnableRender:        c.Render.Enable,
 		EnableProxy:         c.Proxy.Enable,
 		StaticDir:           c.StaticDir,
@@ -151,6 +151,10 @@ type ConfigPage struct {
 	ErrUnknownPage  string `yaml:"500"`
 }
 
+type ConfigDatabase struct {
+	URL string `yaml:"url"`
+}
+
 type ConfigProxy struct {
 	Enable bool `yaml:"enable"` // 是否允许反向代理
 }

config.yaml

@@ -2,20 +2,26 @@
 bind: 127.0.0.1:18080
 # 基础域名
 domain: example.com
+# 持久化存储
+database:
+  # 持久化存储配置
+  url: "memory://"
 auth:
+  type: gitea
   server: https://gitea.com
   # 需要 user , org , repo 的 read 权限
   token: token
 cache:
-  # 配置存储
-  storage: /path/to/config.json
-  # 配置缓存时长
-  ttl: 10m
-
-  # 单个文件最大缓存大小
-  size: 10MB
-  # 总缓存大小
-  max: 1GB
+  # 元数据缓存
+  meta: "memory://"
+  # 元数据缓存时长
+  meta_ttl: 1m
+  # 响应数据缓存
+  blob: "memory://"
+  # 响应数据缓存时长
+  blob_ttl: 1m
+  # 最大单个响应数据缓存大小
+  blob_limit: 10MB
 page:
   # 默认页面分支
   default_branch: gh-pages

main.go

@@ -10,25 +10,48 @@ import (
 	"syscall"
 
 	"go.uber.org/zap"
+	"gopkg.in/yaml.v3"
 
 	"gopkg.d7z.net/gitea-pages/pkg"
 	"gopkg.d7z.net/gitea-pages/pkg/providers"
+	_ "gopkg.d7z.net/gitea-pages/pkg/renders"
 )
 
 var (
 	configPath = "config-local.yaml"
 	debug      = false
+	generate   = false
 )
 
 func init() {
 	flag.StringVar(&configPath, "conf", configPath, "config file path")
+	flag.BoolVar(&generate, "generate", debug, "generate config file")
 	flag.BoolVar(&debug, "debug", debug, "debug mode")
+	flag.Parse()
 }
 
 func main() {
-	flag.Parse()
+	if generate {
+		var cfg Config
+		file, err := os.ReadFile(configPath)
+		if err == nil {
+			_ = yaml.Unmarshal(file, &cfg)
+		}
+		out, err := yaml.Marshal(&cfg)
+		if err != nil {
+			log.Fatal("marshal config file failed", zap.Error(err))
+		}
+		err = os.WriteFile(configPath, out, 0o644)
+		if err != nil {
+			log.Fatal("write config file failed", zap.Error(err))
+		}
+		return
+	}
+
 	call := logInject()
-	defer call()
+	defer func() {
+		_ = call()
+	}()
 	config, err := LoadConfig(configPath)
 	if err != nil {
 		log.Fatalf("fail to load config file: %v", err)
@@ -48,9 +71,7 @@ func main() {
 
 	svc := http.Server{Addr: config.Bind, Handler: giteaServer}
 	go func() {
-		select {
-		case <-ctx.Done():
-		}
+		<-ctx.Done()
 		zap.L().Debug("shutdown gracefully")
 		_ = svc.Close()
 	}()

pkg/core/alias.go

@@ -45,7 +45,7 @@ func (a *DomainAlias) Bind(ctx context.Context, domains []string, owner, repo, b
 			return err
 		}
 	}
-	if domains == nil || len(domains) == 0 {
+	if len(domains) == 0 {
 		return nil
 	}
 	aliasMeta := &Alias{