php-conventional-changelog 项目使用教程

php-conventional-changelog 项目使用教程

php-conventional-changelogA PHP tool built to generate a changelog from a project's commit messages and metadata following the conventionalcommits.org and automate versioning with semver.org.项目地址:https://gitcode.com/gh_mirrors/ph/php-conventional-changelog

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

php-conventional-changelog/
├── bin/
│   └── conventional-changelog
├── src/
│   ├── Changelog.php
│   ├── Commit.php
│   ├── Config.php
│   ├── ...
├── vendor/
│   ├── autoload.php
│   ├── composer/
│   ├── ...
├── CHANGELOG.md
├── composer.json
├── composer.lock
├── LICENSE
├── README.md
└── ...

目录结构介绍

• bin/: 包含可执行文件 conventional-changelog，用于生成变更日志。
• src/: 包含项目的核心代码，包括 Changelog.php、Commit.php、Config.php 等文件。
• vendor/: 包含通过 Composer 安装的依赖库。
• CHANGELOG.md: 生成的变更日志文件。
• composer.json: Composer 配置文件，定义项目的依赖和元数据。
• composer.lock: 锁定文件，记录当前安装的依赖库版本。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍和使用说明。

2. 项目的启动文件介绍

项目的启动文件是 bin/conventional-changelog。这个文件是一个可执行脚本，用于生成项目的变更日志。

启动文件内容概述

#!/usr/bin/env php
<?php

require __DIR__ . '/../vendor/autoload.php';

use ConventionalChangelog\Changelog;
use ConventionalChangelog\Config;

// 加载配置文件
$config = new Config();
$config->load();

// 生成变更日志
$changelog = new Changelog($config);
$changelog->generate();

启动文件功能

• 加载依赖: 通过 vendor/autoload.php 加载项目的依赖库。
• 配置加载: 通过 Config 类加载项目的配置文件。
• 生成变更日志: 通过 Changelog 类生成项目的变更日志。

3. 项目的配置文件介绍

项目的配置文件是 composer.json，它定义了项目的依赖、脚本、命名空间等信息。

配置文件内容概述

{
    "name": "marcocesarato/php-conventional-changelog",
    "description": "A PHP tool built to generate a changelog from a project's commit messages and metadata following the conventionalcommits.org and automate versioning with semver.org",
    "type": "library",
    "license": "GPL-3.0-or-later",
    "require": {
        "php": ">=7.2",
        "ext-json": "*",
        "ext-mbstring": "*"
    },
    "autoload": {
        "psr-4": {
            "ConventionalChangelog\\": "src/"
        }
    },
    "bin": [
        "bin/conventional-changelog"
    ],
    "scripts": {
        "changelog": "php bin/conventional-changelog"
    }
}

配置文件功能

• 项目信息: 定义项目的名称、描述、类型和许可证。
• 依赖管理: 定义项目所需的 PHP 版本和扩展。
• 自动加载: 通过 psr-4 自动加载项目的命名空间和文件。
• 可执行文件: 定义项目的可执行文件路径。
• 脚本: 定义项目的脚本命令，如 changelog。

通过以上内容，您可以了解 php-conventional-changelog 项目的基本结构、启动文件和配置文件的使用方法。

php-conventional-changelogA PHP tool built to generate a changelog from a project's commit messages and metadata following the conventionalcommits.org and automate versioning with semver.org.项目地址:https://gitcode.com/gh_mirrors/ph/php-conventional-changelog