更新github上提交状态的简单命令行
github-commit-status的Python项目详细描述
一个简单的命令行，用于更新github项目中提交的状态和生成状态。图片：：https://travis-ci.org/glenjarvis/github_commit_status.svg？branch=master
：目标：https://travis ci.org/glenjarvis/github_commit_status
：alt:travis tests
。图片：：https://pyup.io/repos/github/glenjarvis/github_commit_status/shield.svg
：目标：https://pyup.io/repos/github/glenjarvis/github_commit_status/
：alt:updates
。图片：：https://pyup.io/repos/github/glenjarvis/github_commit_status/python-3-shield.svg
：目标：https://pyup.io/repos/github/glenjarvis/github_commit_status/
：alt:python 3
。图片：：https://readthedocs.org/projects/github_commit_status/badge/？version=latest
：目标：http://github_commit_status.readthedocs.io/en/latest/？徽章=最新
：alt：文档状态
…图片：：https://ci.appveyor.com/api/projects/status/github/glenjarvis/github_commit_status？branch=master&svg=true
：目标：https://ci.appveyor.com/project/glenjarvis/github_commit_status/branch/master
：alt:appveyor上的Windows生成状态
*`github repo<；https://github.com/glenjarvis/github_commit_status/>；``u
*`联机文档<；https://github commit status.readthedocs.io/en/latest/readme.html>；`
*`免费软件<；https://github.com/glenjarvis/github commit status/blob/master/license>；`
----
背景和用途
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
n对所讨论的代码进行一些检查。
这是检查诸如空白、编码标准、
等内容的好方法。连续集成工具，如travis，使用此工具更新在github的pull请求中看到的提交的状态。mple<；https://github.com/glenjarvis/github_commit_status/blob/master/docs/imgs/figure_1_background.png>；`
这是一个相当简单的集成，您也可以在这里放置自己的支票。
在下面的示例中，我用一个黄色圆圈将状态挂起，并用短语
"你知道你可以改变这个，对吧？"
`自定义状态示例<；https://github.com/glenjarvis/github_commit_status/blob/master/docs/imgs/figure_2_custom_status.png>；`
此命令行工具允许您更新在github中有权访问的任何提交的状态。它是为一门关于源代码管理（git）和github集成的课程而构建的教学工具。但是，它是稳定的，可以无缝地在生产环境中使用，特别是在使用命令行而不是自己的库的环境中。
请求时，您需要提供一些基本信息：
1。具有拉取请求
2的github存储库的名称。要更新的提交sha（例如，pull
请求中的最后一次提交）
3。提交的所需状态：
-"成功"（github显示绿色复选标记）
-"挂起"（github显示黄色圆圈）
-"错误"或"失败"（github显示红色"x"）
4。描述（例如，"你知道你可以改变这个，对吧？"是上面例子中使用的描述
5。授权令牌。这将允许命令像您一样工作。
有关如何创建此令牌的说明如下。
Personal Access Token
^^^^^^^^^^^^^^^^^^^^^
这是
只有经过授权的人才能允许的。你不想有人您没有授权更新拉取请求的状态。
您需要生成一个个人访问令牌，以便此命令行可以像您一样工作。请保护此令牌的安全--它就像密码一样。
这是在您的帐户设置配置中完成的。不要将
项目的设置与您的帐户设置混淆。
profile settings
""""
在右上角，您将看到您的虚拟形象照片（或默认的虚拟形象图像）。单击虚拟形象时，将出现一个带有
菜单选项的下拉菜单。选择**设置**选项。
`右上角菜单<；https://github.com/glenjarvis/github_commit_status/blob/master/docs/imgs/figure_3_account_settings.png>；`
>开发人员设置
""""
在ngs页面，您将看到左侧的另一个
菜单。它是一个较长的菜单，底部看起来类似于下面的
。选择**开发人员设置**：
`开发人员设置菜单<；https://github.com/glenjarvis/github_commit_status/blob/master/docs/imgs/figure_4_developer_settings.png>；` ` ` `<
创建一个个人访问令牌
""""""""""""""""""
在下一页，开发人员设置在Tings页面上，您将看到最后一个菜单。
选择**个人访问令牌**：
`个人访问令牌菜单<；https://github.com/glenjarvis/github_commit_status/blob/master/docs/imgs/figure_5_personal_access tokens.png>；`
1。按下按钮**生成新令牌**。
2。在**令牌描述**中输入"github_commit_status"。这样我们就可以记住这个代币的用途。选中**回购：状态**范围复选框。任何拥有此令牌的人都可以
更新您的github帐户。因此，请保留此令牌的作用域，以便它可以
**仅**更新或访问提交状态。
`新令牌屏幕截图<；https://github.com/glenjarvis/github_commit_status/blob/master/docs/imgs/figure_6_generate_personal_access_tokens.png>；``u
4.滚动到底部，单击绿色的**生成令牌**按钮。
5。现在应该显示您的令牌。此令牌将只在这次显示。
您将无法再次看到它并且无法恢复。
6。请确保您的令牌安全，以便您可以将其用于此程序。请记住，如果
其他人可以访问此令牌，则他们可以更新您的github状态-
，即使您不希望这样做。
示例：提示模式
----
命令行参数正确-系统将提示您输入任何缺少的
必需参数。对于我们班的学生来说，这是一个理想的选择，他们的家庭作业只需要更新几次pull请求。有关更易于编写脚本的模式和示例，请参见下一节。安装：
pip install github_commit_status
2。运行：：
github_commit_status prompt
3。输入您收集的数据（例如，个人访问令牌、提交
sha等）
这里是我在一个项目中使用的示例。记住，不要像我在这里故意那样让
发布您的个人访问令牌。我
确保在发布此消息之前删除此令牌：：
$github_commit_status prompt
commit sha[]：2dd5f9ce1108d69e86344ee6486e644e0299868f
状态：挂起
描述：测试已开始
示例：对于脚本
-
此命令也可用于需要更新github的shell脚本。
出于安全原因，此模式/子命令不提供以下选项：：
--github token
，因为此选项保留在大多数shell历史记录中。相反，应该已经设置
环境变量*github_commit_status_token*。对于
示例，在bash shell中：：
export github_commit_status_token=26fee6a5d440111a2648312d458b6…
1。安装：
pip install github_commit_status
2。要查看可以提供的命令行选项：：
$github_commit_status update--帮助
用法：github_commit_status update[选项]
>如果提供了所有选项，请更新github
选项：
--github repo的repo文本名称sitory[必需]
--提交文本提交的40个字符的sha1字符串。
[必需]
--状态[错误失败挂起成功]
提交的状态[必需]
--测试说明文本说明[必需]
--帮助显示此消息并退出。
3。下面是一个使用示例。记住，您的个人访问令牌
需要在环境变量**github_commit_status_token**中预先设置：
$github_commit_status update--repo=my_target_repo\
--commit="2dd5f9ce1108d69e86344ee6486e64e0299868f"\
--status=pending\
--description="测试正在运行。"
每一点都有帮助，而且总是会有功劳。
你可以在很多方面做出贡献：
*`报告错误<；https://github.com/glenjarvis/github提交状态/issues>；``编写文档<；https://github提交状态。readthedocs.io/>；``修复错误<；https://github.com/glenjarvis/github_commit_status/issues>；``为了最大限度地提高您的努力工作被合并的机会，我们提供了这些指导
来指导您一路走向成功合并的拉取请求：
*：ref:`contribution_link`
*https://github.com/glenjarvis/github_commit_status/blob/master/contribution.rst
：目标：https://travis ci.org/glenjarvis/github_commit_status
：alt:travis tests
。图片：：https://pyup.io/repos/github/glenjarvis/github_commit_status/shield.svg
：目标：https://pyup.io/repos/github/glenjarvis/github_commit_status/
：alt:updates
。图片：：https://pyup.io/repos/github/glenjarvis/github_commit_status/python-3-shield.svg
：目标：https://pyup.io/repos/github/glenjarvis/github_commit_status/
：alt:python 3
。图片：：https://readthedocs.org/projects/github_commit_status/badge/？version=latest
：目标：http://github_commit_status.readthedocs.io/en/latest/？徽章=最新
：alt：文档状态
…图片：：https://ci.appveyor.com/api/projects/status/github/glenjarvis/github_commit_status？branch=master&svg=true
：目标：https://ci.appveyor.com/project/glenjarvis/github_commit_status/branch/master
：alt:appveyor上的Windows生成状态
*`github repo<；https://github.com/glenjarvis/github_commit_status/>；``u
*`联机文档<；https://github commit status.readthedocs.io/en/latest/readme.html>；`
*`免费软件<；https://github.com/glenjarvis/github commit status/blob/master/license>；`
----
背景和用途
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
n对所讨论的代码进行一些检查。
这是检查诸如空白、编码标准、
等内容的好方法。连续集成工具，如travis，使用此工具更新在github的pull请求中看到的提交的状态。mple<；https://github.com/glenjarvis/github_commit_status/blob/master/docs/imgs/figure_1_background.png>；`
这是一个相当简单的集成，您也可以在这里放置自己的支票。
在下面的示例中，我用一个黄色圆圈将状态挂起，并用短语
"你知道你可以改变这个，对吧？"
`自定义状态示例<；https://github.com/glenjarvis/github_commit_status/blob/master/docs/imgs/figure_2_custom_status.png>；`
此命令行工具允许您更新在github中有权访问的任何提交的状态。它是为一门关于源代码管理（git）和github集成的课程而构建的教学工具。但是，它是稳定的，可以无缝地在生产环境中使用，特别是在使用命令行而不是自己的库的环境中。
请求时，您需要提供一些基本信息：
1。具有拉取请求
2的github存储库的名称。要更新的提交sha（例如，pull
请求中的最后一次提交）
3。提交的所需状态：
-"成功"（github显示绿色复选标记）
-"挂起"（github显示黄色圆圈）
-"错误"或"失败"（github显示红色"x"）
4。描述（例如，"你知道你可以改变这个，对吧？"是上面例子中使用的描述
5。授权令牌。这将允许命令像您一样工作。
有关如何创建此令牌的说明如下。
Personal Access Token
^^^^^^^^^^^^^^^^^^^^^
这是
只有经过授权的人才能允许的。你不想有人您没有授权更新拉取请求的状态。
您需要生成一个个人访问令牌，以便此命令行可以像您一样工作。请保护此令牌的安全--它就像密码一样。
这是在您的帐户设置配置中完成的。不要将
项目的设置与您的帐户设置混淆。
profile settings
""""
在右上角，您将看到您的虚拟形象照片（或默认的虚拟形象图像）。单击虚拟形象时，将出现一个带有
菜单选项的下拉菜单。选择**设置**选项。
`右上角菜单<；https://github.com/glenjarvis/github_commit_status/blob/master/docs/imgs/figure_3_account_settings.png>；`
>开发人员设置
""""
在ngs页面，您将看到左侧的另一个
菜单。它是一个较长的菜单，底部看起来类似于下面的
。选择**开发人员设置**：
`开发人员设置菜单<；https://github.com/glenjarvis/github_commit_status/blob/master/docs/imgs/figure_4_developer_settings.png>；` ` ` `<
创建一个个人访问令牌
""""""""""""""""""
在下一页，开发人员设置在Tings页面上，您将看到最后一个菜单。
选择**个人访问令牌**：
`个人访问令牌菜单<；https://github.com/glenjarvis/github_commit_status/blob/master/docs/imgs/figure_5_personal_access tokens.png>；`
1。按下按钮**生成新令牌**。
2。在**令牌描述**中输入"github_commit_status"。这样我们就可以记住这个代币的用途。选中**回购：状态**范围复选框。任何拥有此令牌的人都可以
更新您的github帐户。因此，请保留此令牌的作用域，以便它可以
**仅**更新或访问提交状态。
`新令牌屏幕截图<；https://github.com/glenjarvis/github_commit_status/blob/master/docs/imgs/figure_6_generate_personal_access_tokens.png>；``u
4.滚动到底部，单击绿色的**生成令牌**按钮。
5。现在应该显示您的令牌。此令牌将只在这次显示。
您将无法再次看到它并且无法恢复。
6。请确保您的令牌安全，以便您可以将其用于此程序。请记住，如果
其他人可以访问此令牌，则他们可以更新您的github状态-
，即使您不希望这样做。
示例：提示模式
----
命令行参数正确-系统将提示您输入任何缺少的
必需参数。对于我们班的学生来说，这是一个理想的选择，他们的家庭作业只需要更新几次pull请求。有关更易于编写脚本的模式和示例，请参见下一节。安装：
pip install github_commit_status
2。运行：：
github_commit_status prompt
3。输入您收集的数据（例如，个人访问令牌、提交
sha等）
这里是我在一个项目中使用的示例。记住，不要像我在这里故意那样让
发布您的个人访问令牌。我
确保在发布此消息之前删除此令牌：：
$github_commit_status prompt
commit sha[]：2dd5f9ce1108d69e86344ee6486e644e0299868f
状态：挂起
描述：测试已开始
示例：对于脚本
-
此命令也可用于需要更新github的shell脚本。
出于安全原因，此模式/子命令不提供以下选项：：
--github token
，因为此选项保留在大多数shell历史记录中。相反，应该已经设置
环境变量*github_commit_status_token*。对于
示例，在bash shell中：：
export github_commit_status_token=26fee6a5d440111a2648312d458b6…
1。安装：
pip install github_commit_status
2。要查看可以提供的命令行选项：：
$github_commit_status update--帮助
用法：github_commit_status update[选项]
>如果提供了所有选项，请更新github
选项：
--github repo的repo文本名称sitory[必需]
--提交文本提交的40个字符的sha1字符串。
[必需]
--状态[错误失败挂起成功]
提交的状态[必需]
--测试说明文本说明[必需]
--帮助显示此消息并退出。
3。下面是一个使用示例。记住，您的个人访问令牌
需要在环境变量**github_commit_status_token**中预先设置：
$github_commit_status update--repo=my_target_repo\
--commit="2dd5f9ce1108d69e86344ee6486e64e0299868f"\
--status=pending\
--description="测试正在运行。"
每一点都有帮助，而且总是会有功劳。
你可以在很多方面做出贡献：
*`报告错误<；https://github.com/glenjarvis/github提交状态/issues>；``编写文档<；https://github提交状态。readthedocs.io/>；``修复错误<；https://github.com/glenjarvis/github_commit_status/issues>；``为了最大限度地提高您的努力工作被合并的机会，我们提供了这些指导
来指导您一路走向成功合并的拉取请求：
*：ref:`contribution_link`
*https://github.com/glenjarvis/github_commit_status/blob/master/contribution.rst
欢迎加入QQ群-->： 979659372
