ghch 项目使用教程

ghch 项目使用教程

ghchGenerate changelog from git history, tags and merged pull requests项目地址:https://gitcode.com/gh_mirrors/gh/ghch

1. 项目目录结构及介绍

ghch 项目的目录结构如下：

ghch/
├── cmd/
│   └── ghch/
│       ├── main.go
│       └── ...
├── github/
│   └── workflows/
│       └── ...
├── .gitignore
├── CHANGELOG.md
├── CREDITS
├── LICENSE
├── Makefile
├── README.md
├── changelog.go
├── changelog_test.go
├── cli.go
├── ghch.go
├── ghch_test.go
├── go.mod
├── go.sum
├── octokit.go
└── version.go

目录结构介绍

• cmd/ghch/: 包含项目的启动文件 main.go，这是程序的入口。
• github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• .gitignore: 指定 Git 忽略的文件和目录。
• CHANGELOG.md: 记录项目的变更日志。
• CREDITS: 列出项目的贡献者。
• LICENSE: 项目的开源许可证文件。
• Makefile: 包含项目的构建和测试命令。
• README.md: 项目的介绍和使用说明。
• changelog.go: 处理变更日志的 Go 代码。
• changelog_test.go: 变更日志处理的测试代码。
• cli.go: 命令行接口的实现代码。
• ghch.go: 项目的主要功能实现代码。
• ghch_test.go: 主要功能的测试代码。
• go.mod: Go 模块的依赖管理文件。
• go.sum: Go 模块的依赖校验文件。
• octokit.go: 与 GitHub API 交互的代码。
• version.go: 版本管理相关的代码。

2. 项目启动文件介绍

项目的启动文件位于 cmd/ghch/main.go。这个文件是程序的入口，负责初始化命令行接口并调用相应的功能模块。

main.go 文件内容概览

package main

import (
    "github.com/Songmu/ghch"
    "os"
)

func main() {
    ghch.Run(os.Args)
}

启动文件介绍

• main 函数: 程序的入口点，调用 ghch.Run 函数来执行命令行接口。
• ghch.Run: 处理命令行参数并执行相应的功能。

3. 项目配置文件介绍

ghch 项目没有传统的配置文件，其配置主要通过命令行参数进行。以下是一些常用的命令行参数：

常用命令行参数

• -r /path/to/repo: 指定 Git 仓库的路径。
• --format markdown: 指定输出格式为 Markdown。
• --next-version=v0.30.3: 指定下一个版本的版本号。
• --all: 显示所有变更。
• --from v0.9.0 --to v0.9.1: 指定两个版本之间的变更。

示例命令

ghch -r /path/to/repo --format=markdown --next-version=v0.30.3

这个命令会生成从上一个版本到指定版本的变更日志，并以 Markdown 格式输出。

---

通过以上内容，您可以了解 ghch 项目的目录结构、启动文件和配置方式。希望这篇教程对您有所帮助！

ghchGenerate changelog from git history, tags and merged pull requests项目地址:https://gitcode.com/gh_mirrors/gh/ghch