#git-history #copyright #notes #times #repository #add-update

bin+lib git_copyright

基于 git 历史添加/更新版权注释

2 个版本

0.2.7 2022 年 3 月 19 日
0.2.4 2022 年 3 月 12 日
0.1.0 2022 年 3 月 7 日

12#copyright

自定义许可证

26KB
604 行(不包括注释)

git_copyright

从 git 历史中提取添加/最后修改时间,并根据此添加/更新版权注释。

安装

通过 cargocrates.io 安装 git_copyright 是最简单的方法

cargo install git_copyright

如果您想从源代码构建,请克隆存储库,然后运行

cargo build --release

运行

唯一必需的参数是您的版权应携带的名称,例如

git_copyright --name "MyCompany Ltd."

其他有用的参数

  • --repo:指定除 ./ 之外的其他 repo-root。
  • --config:传递您自己的 YAML 配置文件,包含注释符号和 glob 模式以忽略。
  • --ignore-changes:即使跟踪文件发生变化,也不以错误退出。

完整的命令可能看起来像这样

git_copyright --name "MyCompany Ltd." --repo "../../my_repo" --config "./custom_cfg.yml" --ignore-changes

使用 Docker 运行

您还可以使用预构建的镜像

docker run --rm -u $(id -u) -v $(pwd):/mnt sgasse/git_copyright:v0.2.7 --name "MyCompany Ltd."

开发

在开发过程中,您可以设置日志环境变量以查看调试日志输出

RUST_LOG=debug cargo run -- --repo "../../my_repo" --name "MyCompany Ltd."

依赖项

~10–20MB
~255K SLoC