跳转到主要内容

用于获取或设置github提交状态的命令行应用程序。

项目描述

Latest Version License Downloads Code Health

简介

这个命令行应用程序主要用于持续构建和集成环境。它允许提供所有必要的详细信息以标记提交的状态。对于拉取请求,它可以读取“一切正常”或“谨慎合并”以及可选的CI构建服务器超链接,以及可选的构建失败描述。

这是使用Github v3 API完成的。

这不是一个非常严肃的包,没有进一步发展的计划。它被编写出来,因为现有的github python客户端包,如pygithub3,没有提供与“statuses”API端点通信的能力,并且在构建脚本中提供易于阅读的命令行参数比直接使用curl更受欢迎。

安装

该软件包的稳定版本在PyPI上维护,使用pip进行安装

pip install ghstat

生成个人访问令牌,前往https://github.com/settings/applications,分别启用repo:statuspublic_repoprivate_repo权限。

使用此令牌作为–token参数,或作为环境变量GITHUB_APP_TOKEN

示例

在github.com上失败构建

ghstat.py set --token 0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d \
              --commit 72b74be0de46392a05d8f470b64272b8036e63f8 \
              --user jquast --repo ghstat --state success

将提交的状态作为JSON数据输出到标准输出

ghstat.py get --token 0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d \
              --commit 72b74be0de46392a05d8f470b64272b8036e63f8 \
              --user jquast --repo ghstat

链接到私有bamboo和github enterprise账户

ghstat.py set --token 0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d \
              --commit 0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a \
              --user jquast \
              --repo ghstat \
              --state success \
              --description 'build successful' \
              --target-url 'https://bamboo.mycorp.com/browse/PROJ-BUILD10-1' \
              --base-url 'https://github.mycorp.com/api/v3/'

其他

githubdate:与上述相同,但使用.ini文件而不是命令行参数。

变更

0.3.1
0.3.0
  • 对于长度大于140的描述,将截断并发出警告到标准错误。它将被更改为以文本标记“…”结尾的140个字符长度。

0.2.0
  • 支持Python 3

  • 支持将令牌作为环境变量GITHUB_APP_TOKEN

  • 解决在检索没有任何提交的状态时出现的IndexError。

0.1.0
  • 首次发布到PyPI

项目详情


下载文件

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

源分发

ghstat-0.3.1.tar.gz (4.8 kB 查看哈希值)

上传时间:

构建分发

ghstat-0.3.1-cp27-none-macosx_10_10_x86_64.whl (7.4 kB 查看哈希值)

上传时间: CPython 2.7 macOS 10.10+ x86-64

支持者

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误日志 StatusPage StatusPage 状态页面