跳至主要内容
版本：1.23.8

Gitea 開發

快速開始​

要快速建立一個可用的開發環境，你可以使用 Gitpod。

Open in Gitpod

安裝 Go​

你應該安裝 Go 並正確設置你的 Go 環境。

接下來，安裝 Node.js 和 npm，這是構建 JavaScript 和 CSS 文件所需的。最低支持的 Node.js 版本是 18，建議使用最新的 LTS 版本。

備註

當執行需要外部工具的 make 任務時，如 make watch-backend，Gitea 會自動下載並構建這些工具。要使用這些工具，你必須將 "$GOPATH"/bin 目錄添加到可執行路徑中。如果你不將 Go bin 目錄添加到可執行路徑中，你將需要自行管理這一點。

備註

需要 Go 版本 1.22 或更高版本。Gitea 使用 gofmt 來格式化源代碼。然而，gofmt 的結果可能因 Go 的版本而異。因此，建議安裝我們持續集成運行的 Go 版本。截至最後更新，Go 版本應為 1.23。

要 lint 模板文件，請確保安裝 Python 和 Poetry。

安裝 Make​

Gitea 大量使用 Make 來自動化任務並改進開發。這個指南涵蓋了如何安裝 Make。

在 Linux 上​

使用包管理器安裝。

在 Ubuntu/Debian 上：

sudo apt-get install make

在 Fedora/RHEL/CentOS 上：

sudo yum install make

在 Windows 上​

以下三種 Make 發行版之一可以在 Windows 上運行：

  • 單一二進制構建。複製到某處並添加到 PATH。
  • MinGW-w64 / MSYS2。
    • MSYS2 是一組工具和庫，為你提供了一個易於使用的環境，用於構建、安裝和運行本地 Windows 軟件，它包括 MinGW-w64。
    • 在 MingGW-w64 中，二進制文件稱為 mingw32-make.exe 而不是 make.exe。將 bin 文件夾添加到 PATH。
    • 在 MSYS2 中，你可以直接使用 make。請參閱 MSYS2 Porting。
    • 要使用 CGO_ENABLED（例如：SQLite3）編譯 Gitea，你可能需要使用 tdm-gcc 而不是 MSYS2 gcc，因為 MSYS2 gcc 標頭缺少一些僅限 Windows 的 CRT 函數，如 _beginthread。
  • Chocolatey 包。運行 choco install make
備註

如果你嘗試使用 Windows 命令提示符構建，你可能會遇到問題。建議使用上述提示（Git bash 或 MinGW），但如果你只有命令提示符（或可能是 PowerShell），你可以使用 set 命令設置環境變量，例如 set TAGS=bindata。

下載和克隆 Gitea 源代碼​

推薦的方法是使用 git clone 獲取源代碼。

git clone https://github.com/go-gitea/gitea

（由於 go 模塊的出現，不再需要從 $GOPATH 內構建 go 項目，因此不再推薦使用 go get 方法。）

Fork Gitea​

如上所述下載主要的 Gitea 源代碼。然後，在 GitHub 上 fork Gitea repository，並將 git 遠程 origin 切換到你的 fork 或添加你的 fork 作為另一個遠程：

# 將原始 Gitea origin 重命名為 upstream
git remote rename origin upstream
git remote add origin "git@github.com:$GITHUB_USERNAME/gitea.git"
git fetch --all --prune

或：

# 為我們的 fork 添加新遠程
git remote add "$FORK_NAME" "git@github.com:$GITHUB_USERNAME/gitea.git"
git fetch --all --prune

為了能夠創建 pull request，fork 的倉庫應該被添加為 Gitea 源代碼的遠程。否則，無法推送更改。

構建 Gitea（基礎）​

查看我們的從源代碼構建的說明。

從源代碼構建的最簡單推薦方法是：

TAGS="bindata sqlite sqlite_unlock_notify" make build

build 目標將執行 frontend 和 backend 子目標。如果存在 bindata 標籤，前端文件將被編譯到二進制文件中。建議在進行前端開發時省略該標籤，以便更改能夠反映出來。

查看 make help 以獲取所有可用的 make 目標。還可以查看 .drone.yml 了解我們的持續集成如何工作。

持續構建​

要運行並在源文件更改時持續重建：

# 前端和後端
make watch

# 或：僅監視前端文件（html/js/css）
make watch-frontend

# 或：僅監視後端文件（go）
make watch-backend

在 macOS 上，監視所有後端源文件可能會達到默認的打開文件限制，可以通過 ulimit -n 12288 為當前 shell 或在你的 shell 啟動文件中為所有未來的 shell 增加此限制。

格式化、代碼分析和拼寫檢查​

我們的持續集成將拒絕未通過代碼 linter（包括格式檢查、代碼分析和拼寫檢查）的 PR。

你應該格式化你的代碼：

make fmt

並 lint 源代碼：

# lint 前端和後端代碼
make lint
# 僅 lint 後端代碼
make lint-backend

注意：gofmt 的結果取決於當前的 Go 版本。你應該運行與持續集成服務器上相同版本的 Go，如上所述。

處理 JS 和 CSS​

前端開發應遵循前端開發指南

要使用前端資源構建，可以使用上述的 watch-frontend 目標或僅構建一次：

make build && ./gitea

在提交之前，確保 linter 通過：

make lint-frontend

配置本地 ElasticSearch 實例​

使用 docker 啟動本地 ElasticSearch 實例：

mkdir -p $(pwd)/data/elasticsearch
sudo chown -R 1000:1000 $(pwd)/data/elasticsearch
docker run --rm --memory="4g" -p 127.0.0.1:9200:9200 -p 127.0.0.1:9300:9300 -e "discovery.type=single-node" -v "$(pwd)/data/elasticsearch:/usr/share/elasticsearch/data" docker.elastic.co/elasticsearch/elasticsearch:7.16.3

配置 app.ini：

[indexer]
ISSUE_INDEXER_TYPE = elasticsearch
ISSUE_INDEXER_CONN_STR = http://elastic:changeme@localhost:9200
REPO_INDEXER_ENABLED = true
REPO_INDEXER_TYPE = elasticsearch
REPO_INDEXER_CONN_STR = http://elastic:changeme@localhost:9200

構建和添加 SVG​

SVG 圖標使用 make svg 目標構建，將圖標源編譯到輸出目錄 public/assets/img/svg 中。自定義圖標可以添加到 web_src/svg 目錄中。

Gitea 標誌的 PNG 和 SVG 版本是從單個 SVG 源文件 assets/logo.svg 使用 TAGS="gitea" make generate-images 目標構建的。要運行它，必須有 Node.js 和 npm。

同樣的過程也可以用來從 SVG 源文件生成自定義標誌 PNG，只需更新 assets/logo.svg 並運行 make generate-images。省略 gitea 標籤將僅更新用戶指定的標誌文件。

更新 API​

在創建新 API 路由或修改現有 API 路由時，你必須使用 go-swagger 註釋更新和/或創建 Swagger 文檔。這些註釋的結構在規範中描述。如果你想了解更多關於 Swagger 結構的信息，可以查看 Swagger 2.0 文檔 或與添加新 API 端點的先前 PR 進行比較，例如 PR #5483

你應該小心不要破壞依賴於穩定 API 的下游用戶。一般來說，添加是可以接受的，但刪除或對 API 的根本性更改將被拒絕。

一旦你創建或更改了一個 API 端點，請使用以下命令重新生成 Swagger 文檔：

make generate-swagger

你應該驗證生成的 Swagger 文件：

make swagger-validate

你應該提交更改的 swagger JSON 文件。持續集成服務器將使用以下命令檢查是否已完成此操作：

make swagger-check
備註

請注意，你應該使用 Swagger 2.0 文檔，而不是 OpenAPI 3 文檔。

創建新配置選項​

在創建新配置選項時，僅將它們添加到 modules/setting 文件中是不夠的。你應該將信息添加到 custom/conf/app.ini 和 docs/content/doc/administer/config-cheat-sheet.zh-tw.md 中的配置速查表。

更改標誌​

在更改 Gitea 標誌 SVG 時，你需要運行並提交以下命令的結果：

make generate-images

這將創建必要的 Gitea favicon 和其他圖標。

數據庫遷移​

如果你對 models/ 目錄中的任何數據庫持久化結構進行了重大更改，你將需要進行新的遷移。這些可以在 models/migrations/ 中找到。你可以使用以下命令確保你的遷移適用於主要數據庫類型：

make test-sqlite-migration # 使用 SQLite 進行測試，並根據需要切換到適當的數據庫

測試​

Gitea 運行兩種類型的測試：單元測試和集成測試。

單元測試​

單元測試由 *_test.go 覆蓋在 go test 系統中。你可以設置環境變量 GITEA_UNIT_TESTS_LOG_SQL=1 以在詳細模式下運行測試時顯示所有 SQL 語句（即設置 GOTESTFLAGS=-v）。

TAGS="bindata sqlite sqlite_unlock_notify" make test # 運行單元測試

集成測試​

單元測試無法完全測試 Gitea。因此，我們編寫了集成測試；然而，這些測試依賴於數據庫。

TAGS="bindata sqlite sqlite_unlock_notify" make build test-sqlite

將在 SQLite 環境中運行集成測試。集成測試需要安裝 git lfs。其他數據庫測試可用，但可能需要調整本地環境。

查看 tests/integration/README.md 以獲取更多信息以及如何運行單個測試。

PR 測試​

我們的持續集成將測試代碼是否通過其單元測試，並且所有支持的數據庫將在 Docker 環境中通過集成測試。還將測試從 Gitea 的幾個最近版本的遷移。

請提交你的 PR，並根據需要添加額外的測試和集成測試。

網站文檔​

網站文檔位於 docs/ 中。如果你更改了這些文檔，可以使用以下命令測試你的更改以確保它們通過持續集成：

make lint-md

Visual Studio Code​

在 contrib/ide/vscode 中提供了 launch.json 和 tasks.json 用於 Visual Studio Code。查看 contrib/ide/README.md 以獲取更多信息。

GoLand​

點擊 /main.go 中 func main() 函數上的 Run Application 箭頭可以快速啟動可調試的 Gitea 實例。

Run/Debug Configuration 中的 Output Directory 必須設置為 gitea 項目目錄（包含 main.go 和 go.mod），否則啟動的實例的工作目錄將是 GoLand 的臨時目錄，並阻止 Gitea 在開發環境中加載動態資源（例如：模板）。

要在 GoLand 中使用 SQLite 運行單元測試，請在 Run/Debug Configuration 的 Go tool arguments 中設置 -tags sqlite,sqlite_unlock_notify。

提交 PR​

一旦你對更改感到滿意，請將它們推送並打開一個 pull request。建議允許 Gitea 管理員和所有者修改你的 PR 分支，因為我們需要在合併之前將其更新到 main，並且/或者可能能夠直接幫助修復問題。

任何 PR 需要兩個 Gitea 維護者的批准，並且需要通過持續集成。查看我們的 CONTRIBUTING.md 文檔。

如果你需要更多幫助，請加入 Discord #Develop 聊天。

就是這樣！你已經準備好開發 Gitea 了。