kuma-deployer

在古时候，群狼出没，伦敦上空笼罩着浓雾，库玛的穷苦佃农不得不像卡夫卡笔下的奴隶一样跋涉于 https://kuma.readthedocs.io/en/latest/deploy.html。那已经过去了。现在是。

这里脚本化了Kuma部署过程中的所有可自动化操作。

限制和注意事项

希望所有暂时性的限制和注意事项。

有些事情很难做，比如从Jenkins中提取信息，因为它需要身份验证和VPN。

另一件事是，所有当前的命令都是独立的，用户需要知道它们的运行顺序。理想情况下，应该将它们封装成一个单独的命令，但这有点棘手，因为它需要等待和外部检查。

入门

您需要一个GitHub访问令牌。前往 github.com/settings/tokens 创建令牌，将其复制并粘贴到您的 .env 文件中或使用 export。例如：

cat .env
GITHUB_ACCESS_TOKEN=a36f6736...

pip install kuma-deployer
kuma-deployer --help

如果您不使用 .env 文件，您可以使用

GITHUB_ACCESS_TOKEN=a36f6736... kuma-deployer --help

注意！带有 GITHUB_ACCESS_TOKEN 的 .env 文件需要位于 当前工作目录 中。即您运行 kuma-deployer 的位置。所以不一定是您的 kuma 目录所在的位置（如果这两个位置不同）。

目标

目标是您只需安装此脚本，输入 kuma-deploy，然后坐下来放松，如果运气好，MDN就能完全升级、部署并启用。

贡献

克隆此仓库然后运行

pip install -e ".[dev]"

应该已经安装了 CLI kuma-deployer

kuma-deployer --help

如果你想要提交 PR，请确保其格式使用 black，并且通过 flake8 检查。

你可以通过运行以下命令来检查所有文件是否通过 flake8 检查：

flake8 deployer

要检查所有文件是否根据 black 格式化，请运行以下命令：

black --check deployer

通过安装 therapist，可以简化所有代码风格问题。它默认应该被安装，但将其设置为 git 的 pre-commit 钩子是可选的。以下是设置它的方法：

therapist install

现在，下次当你尝试提交一个包含 black 或 flake8 违规的 .py 文件时，它将提醒你并阻止提交。你可以像这样覆盖它：

git commit -a -m "I know what I'm doing"

要运行 所有 代码风格和 lint 检查器，你也可以使用以下命令与 therapist 一起使用：

therapist run --use-tracked-files

有些问题不能自动修复，例如，black 违规可以通过以下方式进行修复：

therapist run --use-tracked-files --fix

贡献和使用

如果你想使用全局安装的可执行文件 kuma-deployer，但不想每次尝试更改都依赖于新的 PyPI 发布版本，请使用以下方法：

# If you use a virtualenv, deactivate it first
deactive
# Use the global pip (or pip3) on your system
pip3 install -e .

如果你这样做，你可以使用此存储库来在你的系统中安装。