跳转到主要内容

一个用于检查您被忽视的GitHub Actions工作流程状态的仪表板。

项目描述

ESHGHAM

GitHub Actions监控的健康摘要执行器(ESHGHAM,也是一个波斯语的爱称,翻译为“我的爱”)是一个检查您被忽视的GitHub Actions状态的仪表板。

您是否维护了很多GitHub仓库?即使它们不是很活跃,您也想保持它们活跃的项目?

您担心会错过GitHub在计划的工作流程变得不活跃时发送给您的警告电子邮件吗?您以前错过过它们吗?只是在用户抱怨与依赖项新版本不兼容后,才发现CI已经几个月没有运行了?

您担心同事可能负责最新的合并,并可能忽略失败的CI通知吗?

那么,ESHGHAM就是为您准备的!

ESHGHAM是一个用于检查您计划的工作流程的小型命令行实用程序。

以下是在实践中它的样子

The command eshgham config.yaml tells if your GitHub actions are inactive or failing

当工作流程失败或处于不活跃状态时,摘要将以失败或未激活的工作流程的链接结束。对于失败的工作流程,这将链接到一个失败的作业运行报告。对于未激活的工作流程,这将链接到工作流程页面,您可以在其中点击“启用工作流程”按钮以重新激活它。

安装

python -m pip install eshgham

用法

usage: eshgham [-h] [--token TOKEN] [--json] [--exit-code EXIT_CODE]
               workflows_yaml

ESHGHAM: The Executive Summarizer of Health for GitHub Actions Monitoring. A
dashboard for your neglected GitHub Actions workflows. Version 0.1.0.dev0.

positional arguments:
  workflows_yaml        Workflows in YAML format. This is provided with
                        repository 'owner/repo_name' as a string key, and a
                        list of workflow filenames as the value. The special
                        key 'token' may be used for the GitHub personal access
                        token.

options:
  -h, --help            show this help message and exit
  --token TOKEN         GitHub personal access token. May also be provided
                        using 'token' as a key in the workflow YAML file, or
                        in the environment variable `GITHUB_TOKEN`. The
                        command argument takes precedence, followed bythe
                        environment variable, and finally the YAML
                        specification.
  --json                Output as JSON instead of outputting to screen. The
                        JSON object has keys 'OK', 'INACTIVATED', and
                        'FAILED', with a list of workflows as values. Each
                        workflow has the repository name, the workflow name,
                        and a URL. For passing/failing workflows, this URL
                        points to the last run. For inactive workflows, the
                        URL points to the workflow itself.
  --exit-code EXIT_CODE
                        Exit code to return if there are any inactive/failing
                        workflows. Runs with no inactive/failing workflows
                        always exit with 0.

YAML配置

YAML配置是仓库名称到工作流程YAML文件名列表的映射。它还允许(可选)具有值的键 token,该值将是您的GitHub个人访问令牌。

以下是我的配置文件,仅供参考(显然,我的GitHub令牌已被删除)。

openpathsampling/openpathsampling:
  - tests.yml
  - check-openmm-rc.yml
openpathsampling/openpathsampling-cli:
  - test-suite.yml
openpathsampling/ops_tutorial:
  - ci.yml
openpathsampling/ops_additional_examples:
  - tests.yml
dwhswenson/contact_map:
  - unit-tests.yml
dwhswenson/autorelease:
  - unit-tests.yml
dwhswenson/ops-storage-notebooks:
  - tests.yml
dwhswenson/conda-rc-check:
  - example_use.yml
dwhswenson/plugcli:
  - ci.yml
# I'm okay with these being inactive, but maybe I'll activate them again
# someday
#dwhswenson/ghcontribs:
  #- tests.yml
#dwhswenson/fabulous-paths:
  #- tests.yml
token: ghp_<blahblahblah>

项目详情


下载文件

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

源代码分发

eshgham-0.1.0.tar.gz (11.2 kB 查看哈希值)

上传时间 源代码

构建分发

eshgham-0.1.0-py3-none-any.whl (9.6 kB 查看哈希值)

上传时间 Python 3

支持

AWSAWS 云计算和安全赞助商 DatadogDatadog 监控 FastlyFastly CDN GoogleGoogle 下载分析 MicrosoftMicrosoft PSF赞助商 PingdomPingdom 监控 SentrySentry 错误日志 StatusPageStatusPage 状态页面