开源项目 `deployments` 使用教程

开源项目 deployments 使用教程

deployments 🔖 GitHub Action for working painlessly with deployment statuses 项目地址: https://gitcode.com/gh_mirrors/de/deployments

1. 项目的目录结构及介绍

deployments/
├── cmd/
│   ├── deployments/
│   │   └── main.go
├── internal/
│   ├── app/
│   │   └── app.go
│   ├── config/
│   │   └── config.go
│   ├── db/
│   │   └── db.go
│   ├── handlers/
│   │   └── handlers.go
│   ├── models/
│   │   └── models.go
│   └── utils/
│       └── utils.go
├── pkg/
│   └── logger/
│       └── logger.go
├── .env.example
├── .gitignore
├── go.mod
├── go.sum
└── README.md

• cmd/: 包含项目的入口文件，通常是 main.go。
• internal/: 包含项目的内部逻辑，包括应用逻辑、配置、数据库处理、HTTP 处理器、数据模型和工具函数。
• pkg/: 包含项目的公共包，通常是一些可重用的代码，如日志记录。
• .env.example: 环境变量的示例文件。
• .gitignore: Git 忽略文件列表。
• go.mod 和 go.sum: Go 模块依赖管理文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件位于 cmd/deployments/main.go。该文件是整个应用的入口点，负责初始化配置、数据库连接、日志记录等，并启动 HTTP 服务器。

package main

import (
    "deployments/internal/app"
    "deployments/internal/config"
    "deployments/pkg/logger"
    "log"
)

func main() {
    // 加载配置
    cfg, err := config.LoadConfig()
    if err != nil {
        log.Fatalf("无法加载配置: %v", err)
    }

    // 初始化日志
    logger.Init(cfg.LogLevel)

    // 启动应用
    app.Run(cfg)
}

3. 项目的配置文件介绍

项目的配置文件通常通过环境变量加载，示例文件为 .env.example。实际使用时，应将 .env.example 复制为 .env 并根据需要修改其中的配置项。

# 数据库配置
DB_HOST=localhost
DB_PORT=5432
DB_USER=user
DB_PASSWORD=password
DB_NAME=deployments

# 日志级别
LOG_LEVEL=info

# HTTP 服务器配置
HTTP_PORT=8080

配置文件的加载逻辑通常在 internal/config/config.go 中实现。

package config

import (
    "github.com/joho/godotenv"
    "os"
)

type Config struct {
    DBHost     string
    DBPort     string
    DBUser     string
    DBPassword string
    DBName     string
    LogLevel   string
    HTTPPort   string
}

func LoadConfig() (*Config, error) {
    if err := godotenv.Load(); err != nil {
        return nil, err
    }

    return &Config{
        DBHost:     os.Getenv("DB_HOST"),
        DBPort:     os.Getenv("DB_PORT"),
        DBUser:     os.Getenv("DB_USER"),
        DBPassword: os.Getenv("DB_PASSWORD"),
        DBName:     os.Getenv("DB_NAME"),
        LogLevel:   os.Getenv("LOG_LEVEL"),
        HTTPPort:   os.Getenv("HTTP_PORT"),
    }, nil
}

通过以上配置，项目可以灵活地适应不同的运行环境。

deployments 🔖 GitHub Action for working painlessly with deployment statuses 项目地址: https://gitcode.com/gh_mirrors/de/deployments