许可证更新器

每年我都会检查项目并更新许可证字符串。对于几个项目来说没问题，但如果有很多项目，那就变得非常耗时！因此，我制作了这个许可证更新器，以完成我所需的一切。

待办事项

动作更新器将使更新动作变得简单

• 🥑 更新语法和命令
• 🥑 动作版本，无论是发布还是提交
• 🥑 预览、写入新文件或就地写入！
• 🥑 作为GitHub动作工作流程运行，用于年度检查！

您可以在 ⭐️ 文档 ⭐️ 中查看完整详情！

⭐️ 快速入门 ⭐️

安装

该模块可在PyPI上作为 license-updater 获取，要安装，我们首先建议某种类型的虚拟环境

$ python -m venv env
$ source env/bin/activate

然后使用pip从PyPI安装

$ pip install license-updater

用法

对于以下所有命令，动作更新器可以接受一个包含yaml文件的目录，或者一个匹配GitHub动作模式的单个yaml文件。

查看可用的更新器（以及描述）

$ license-updater list-updaters

在将更改写入文件之前，您可能需要检测（预览）。

# Run all updaters
$ license-updater detect .github/workfows/main.yaml

# Only detect for the setoutput updater
$ license-updater detect -u setoutput .github/workfows/main.yaml

最后，将更新写入文件！

$ license-updater update .github/workfows/main.yaml

🎨 屏幕截图 🎨

如果文件有更新，它将在终端中打印更新的文件以供预览。

在运行 update（如下所述）之后，您将看到所有绿色！

跨多个文件运行

就这样！这个操作附带几个更新器，它们会查找特定的方面来进行代码检查或更新。如果您有新的更新请求，请提交一个问题。

功能想法

这可能很容易扩展，允许进行更多的“代码检查”风格的操作，以反映对风格的偏好，例如

$ license-updater lint .github/workflows/main.yaml

如果您对此感兴趣，请提交一个问题以进一步讨论！我们目前进行了一些基本的代码检查，因为yaml加载库对保存时的间距等有偏好。

😁️ 贡献者 😁️

我们使用all-contributors工具生成下面的贡献者图形。

Vanessasaurus 💻

Mike Henry 💻

许可证

此代码根据MPL 2.0许可协议授权。