
想象一下,每到新年伊始,你的开源项目都需要更新许可证文件(比如 LICENSE 或 LICENSE.md)中的版权年份。如果你的项目规模不大,可能还能勉强手动处理。但当项目文件增多,或者你维护着多个项目时,这项任务就变得异常繁琐和耗时。更糟糕的是,如果忘记更新,你的项目可能会在法律合规性上留下隐患。
许多维护者对此怨声载道,甚至有贡献者提交 PR 只是为了更新许可证年份,这无疑增加了维护者的工作量。难道就没有一种优雅的方式来解决这个问题吗?当然有!ergebnis/license 这个 Composer 包就是为此而生。
ergebnis/license:许可证抽象与自动化利器ergebnis/license 提供了一个开放源代码许可证的抽象层。它的核心思想是将许可证信息(如类型、版权持有者、年份范围等)程序化,从而实现自动化管理。通过 Composer,你可以轻松地将其集成到你的项目中。
安装 ergebnis/license
通常,这个库只在开发环境中使用,所以我们使用 --dev 标志进行安装:
<code class="bash">composer require --dev ergebnis/license</code>
与 friendsofphp/php-cs-fixer 强强联手
ergebnis/license 的真正威力在于它能与 friendsofphp/php-cs-fixer(一个 PHP 代码风格修复工具)无缝集成。通过 php-cs-fixer 的配置文件 .php-cs-fixer.php,我们可以实现以下自动化:
ergebnis/license 可以根据你定义的许可证类型和信息,自动生成或更新项目根目录下的 LICENSE 或 LICENSE.md 文件。让我们看一个使用 MIT 许可证的 .php-cs-fixer.php 示例:
<pre class="brush:php;toolbar:false;"><?php
declare(strict_types=1);
use Ergebnis\License;
use PhpCsFixer\Config;
use PhpCsFixer\Finder;
// 1. 定义许可证信息
$license = License\Type\MIT::text(
__DIR__ . '/LICENSE.md', // 许可证文件路径
License\Range::since(
License\Year::fromString('2023'), // 你的项目开始年份
new DateTimeZone('UTC')
),
License\Holder::fromString('你的公司或名字'), // 版权持有者
License\Url::fromString('https://github.com/你的/项目') // 项目URL
);
// 2. 将许可证内容保存到文件
$license->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() 是关键。它会根据当前年份自动计算出 2023-当前年份 这样的范围。当你在新的一年运行 php-cs-fixer 时,它会自动检测到许可证年份需要更新,并修复文件。
仅仅通过 php-cs-fixer 自动化本地更新还不够,我们希望在不干预的情况下,让许可证年份的更新在云端自动完成。GitHub Actions 是一个完美的工具,可以帮助我们实现这一点。
我们可以设置一个计划任务(Scheduled Workflow),例如在每年的 1 月 1 日运行,它会执行以下操作:
php-cs-fixer。php-cs-fixer 检测到许可证年份需要更新(因为新的一年到了),它会自动创建一个 Pull Request 来提交这些更改。以下是一个 GitHub Actions 的 YAML 配置示例:
<pre class="brush:php;toolbar:false;">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@你的域名.com>" # 可以使用一个 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。你只需要简单地审查并合并即可,彻底告别手动操作的烦恼!
使用 ergebnis/license 结合 php-cs-fixer 和 GitHub Actions 带来的优势是显而易见的:
这种自动化方案不仅适用于 MIT 许可证,ergebnis/license 也支持 None 类型(适用于闭源项目,仅需头注释)以及其他常见的许可证类型。如果你需要更多类型,甚至可以贡献代码来扩展它。
在现代软件开发中,自动化是提升效率和减少错误的关键。ergebnis/license 为开源项目的许可证管理提供了一个优雅而强大的自动化解决方案。如果你还在为每年更新许可证年份而烦恼,不妨尝试一下这个 Composer 包,它将彻底改变你的工作流,让你的开源项目维护变得前所未有的轻松和高效!
以上就是如何解决开源项目许可证年份手动更新的烦恼,ergebnis/license助你实现自动化管理的详细内容,更多请关注php中文网其它相关文章!
每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号