如何解决开源项目许可证年份手动更新的烦恼，ergebnis/license助你实现自动化管理_网络技术

如何解决开源项目许可证年份手动更新的烦恼，ergebnis/license助你实现自动化管理

发布时间 - 2025-10-19 00:00:00 点击率：次

可以通过一下地址学习composer：学习地址

告别手动更新：开源项目许可证管理的新范式

想象一下，每到新年伊始，你的开源项目都需要更新许可证文件（比如 LICENSE 或 LICENSE.md）中的版权年份。如果你的项目规模不大，可能还能勉强手动处理。但当项目文件增多，或者你维护着多个项目时，这项任务就变得异常繁琐和耗时。更糟糕的是，如果忘记更新，你的项目可能会在法律合规性上留下隐患。

许多维护者对此怨声载道，甚至有贡献者提交 PR 只是为了更新许可证年份，这无疑增加了维护者的工作量。难道就没有一种优雅的方式来解决这个问题吗？当然有！ergebnis/license 这个 Composer 包就是为此而生。

`ergebnis/license`：许可证抽象与自动化利器

ergebnis/license 提供了一个开放源代码许可证的抽象层。它的核心思想是将许可证信息（如类型、版权持有者、年份范围等）程序化，从而实现自动化管理。通过 Composer，你可以轻松地将其集成到你的项目中。

安装 ergebnis/license

通常，这个库只在开发环境中使用，所以我们使用 --dev 标志进行安装：

composer require --dev ergebnis/license

与 friendsofphp/php-cs-fixer 强强联手

ergebnis/license 的真正威力在于它能与 friendsofphp/php-cs-fixer（一个 PHP 代码风格修复工具）无缝集成。通过 php-cs-fixer 的配置文件 .php-cs-fixer.php，我们可以实现以下自动化：

自动生成/更新许可证文件： ergebnis/license 可以根据你定义的许可证类型和信息，自动生成或更新项目根目录下的 LICENSE 或 LICENSE.md 文件。
自动更新 PHP 文件头注释： 它能确保所有 PHP 文件中的许可证头注释（例如 PHPDoc 块）始终包含正确的版权年份范围。

让我们看一个使用 MIT 许可证的 .php-cs-fixer.php 示例：

save();

// 3. 配置 php-cs-fixer
$finder = Finder::create()->in(__DIR__);

return Config::create()
    ->setFinder($finder)
    ->setRules([
        'header_comment' => [
            'comment_type' => 'PHPDoc',
            'header' => $license->header(), // 使用 license 对象生成的头注释
            'location' => 'after_declare_strict',
            'separate' => 'both',
        ],
    ]);

在这个配置中，License\Range::since() 是关键。它会根据当前年份自动计算出 2025-当前年份 这样的范围。当你在新的一年运行 php-cs-fixer 时，它会自动检测到许可证年份需要更新，并修复文件。

利用 GitHub Actions 实现完全自动化

仅仅通过 php-cs-fixer 自动化本地更新还不够，我们希望在不干预的情况下，让许可证年份的更新在云端自动完成。GitHub Actions 是一个完美的工具，可以帮助我们实现这一点。

我们可以设置一个计划任务（Scheduled Workflow），例如在每年的 1 月 1 日运行，它会执行以下操作：

检出代码。
安装 Composer 依赖。
运行 php-cs-fixer。
如果 php-cs-fixer 检测到许可证年份需要更新（因为新的一年到了），它会自动创建一个 Pull Request 来提交这些更改。

以下是一个 GitHub Actions 的 YAML 配置示例：

name: "License Year Update"

on:
  schedule:
    - cron: "1 0 1 1 *" # 每年1月1日0点1分 (UTC) 运行

jobs:
  license:
    name: "Update License Year"
    runs-on: "ubuntu-latest"
    steps:
      - name: "Checkout code"
        uses: "actions/checkout@v3" # 使用最新版本

      - name: "Install dependencies with composer"
        run: "composer install --no-interaction --no-progress --no-suggest"

      - name: "Run friendsofphp/php-cs-fixer"
        # --diff --dry-run --verbose 可以在 PR 中看到具体改动
        run: "vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.php --diff --dry-run --verbose"

      - name: "Open pull request updating license year"
        # 这个 action 会检查是否有文件被修改，有则创建或更新 PR
        uses: "gr2m/create-or-update-pull-request-action@v1.2.9"
        with:
          author: "你的机器人名字 " # 可以使用一个 bot 用户
          branch: "feature/license-year-update"
          body: |
            This PR automatically updates the license year.
            - [x] updates the license year
          commit-message: "Enhancement: Update license year"
          path: "."
          title: "Enhancement: Update license year"
        env:
          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}" # 或者你为 bot 配置的 TOKEN

通过这个工作流，每当新的一年到来，GitHub Actions 就会自动检查并更新许可证年份，然后向你的仓库提交一个 Pull Request。你只需要简单地审查并合并即可，彻底告别手动操作的烦恼！