跳转到主要内容

更新已弃用命令、版本和其他GitHub动作

项目描述

Action Updater

PyPI version main

docs/assets/img/logo/action-updater-small.png

All Contributors

Action Updater将使更新动作变得容易

  • 🥑 更新的语法和命令
  • 🥑 动作的版本,无论是发布还是提交
  • 🥑 预览,写入新文件,或原地写入!
  • 🥑 作为GitHub动作工作流运行,进行年度检查!

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

⭐️ 快速开始 ⭐️

安装

该模块可在pypi上作为action-updater使用,要安装,我们首先推荐某种虚拟环境

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

然后使用pip从pypi安装

$ pip install action-updater

使用方法

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

查看可用的更新器(及其描述)

$ action-updater list-updaters

在将更改写入文件之前,您可能需要检测(以预览)。

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

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

最后,将更新写入文件!

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

🎨 屏幕截图 🎨

如果有文件有更新,它将打印到终端以预览更新的文件。

docs/assets/img/detect.png

运行update(如下所述)后,您将看到所有绿色!

docs/assets/img/clean.png

跨多个文件运行

docs/assets/img/updates.png

就是这样!该动作包含几个更新器,这些更新器将查找特定方面以进行lint或更新。如果您有新的更新请求,请打开问题

功能想法

这可以很容易地扩展以允许更多的“linting”风格操作,以反映对风格的偏好,例如:

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

如果您对此感兴趣,请打开一个issue进一步讨论!我们目前进行一些基本的linting,因为yaml加载库在保存时对间距等有偏好。

😁️ 贡献者 😁️

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

Vanessasaurus
Vanessasaurus

💻
Mike Henry
Mike Henry

💻

许可证

此代码根据MPL 2.0 LICENSE授权。

项目详情


下载文件

下载您平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源分发

action-updater-0.0.16.tar.gz (35.9 kB 查看哈希值)

上传时间

构建分发

action_updater-0.0.16-py3-none-any.whl (46.8 kB 查看哈希值)

上传时间 Python 3

支持者