Smokeshow CLI

用于部署临时网站的命令行界面，更多信息请参阅smokeshow.helpmanual.io。

安装

pip install smokeshow

用法

要获取使用帮助，请运行

smokeshow --help

要生成上传密钥，请使用

smokeshow generate-key

然后您应该使用以下命令将密钥设置为环境变量

export SMOKESHOW_AUTH_KEY='...'

有了这个，您就可以上传一个网站

smokeshow upload path/to/upload

要获取更多帮助，请运行 smokeshow upload --help。如果您在没有设置SMOKESHOW_AUTH_KEY环境变量或使用--auth-key选项的情况下运行smokeshow upload，smokeshow将在上传网站之前生成一个新的上传密钥。

如果您在处理Python版本和访问CLI方面遇到问题，您还可以通过以下方式作为脚本运行smokeshow库模块

python -m smokeshow

GitHub动作 & 提交状态集成

我主要构建smokeshow来预览使用github actions生成的文档和覆盖率。

smokeshow因此直接与GitHub动作集成，在提交中添加状态并链接到新创建的临时网站。

此外，smokeshow 具有自定义逻辑，可以从coverage.py的HTML覆盖率报告中提取总覆盖率数字，用于注释提交状态更新并决定提交状态是“成功”还是“失败”。

从github action设置提交状态的示例

- run: smokeshow upload cli/htmlcov
  env:
    SMOKESHOW_GITHUB_STATUS_DESCRIPTION: CLI Coverage {coverage-percentage}
    SMOKESHOW_GITHUB_COVERAGE_THRESHOLD: 50
    SMOKESHOW_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    SMOKESHOW_GITHUB_PR_HEAD_SHA: ${{ github.event.pull_request.head.sha }}

(以下内容直接取自smokeshow的CI，请见此处)

设置提交状态时使用以下环境变量

• SMOKESHOW_GITHUB_STATUS_DESCRIPTION（或使用CLI选项--github-status-description）设置提交状态的描述；字符串{coverage-percentage}具有特殊含义，如果可以从上传的根index.html文件中提取实际覆盖率百分比，则将其替换为实际覆盖率百分比，此选项必须设置以便smokeshow设置提交状态
• SMOKESHOW_GITHUB_COVERAGE_THRESHOLD（或使用CLI选项--github-coverage-threshold）决定提交状态更新的“状态”；如果总覆盖率数字不可用或高于阈值，则使用success，如果覆盖率数字低于此阈值，则使用failure
• SMOKESHOW_GITHUB_TOKEN用于身份验证状态更新，更多详细信息请见此处
• SMOKESHOW_GITHUB_PR_HEAD_SHA或如果省略或为空则使用GITHUB_SHA（由github action自动设置）来决定要设置状态的提交。上面的SMOKESHOW_GITHUB_PR_HEAD_SHA: ${{ github.event.pull_request.head.sha }}技巧是必需的，因为github将GITHUB_SHA环境变量设置为一个合并提交，这不是你想要的
• SMOKESHOW_GITHUB_CONTEXT为github状态上下文添加后缀
• GITHUB_REPOSITORY由github action自动设置，用于选择要设置状态的仓库