Paul Mclendahand 3.1.0

配置pmac

pmac需要知道GitHub用户和GitHub项目。

您可以在 pyproject.toml 文件中设置配置

[tool.paul-mclendahand]
github_user = "user"
github_project = "project"
main_branch = "git-main-branch-name"

或者您可以在 setup.cfg 文件中设置配置

[tool:paul-mclendahand]
github_user=user
github_project=project
main_branch=git-main-branch-name

您可以使用环境变量覆盖配置变量

PMAC_GITHUB_USER=user
PMAC_GITHUB_PROJECT=project
PMAC_MAIN_BRANCH=git-main-branch-name

可选

您还可以使用GitHub个人访问令牌。您可以在 PMAC_GITHUB_API_TOKEN 环境变量中设置它。

例如

PMAC_GITHUB_API_TOKEN=abcdef0000000000000000000000000000000000 pmac listprs

使用pmac

在您配置了git之后，您可以使用 pmac 如此

1. 创建一个新分支

   git checkout <MAIN-BRANCH>
   git checkout -b update-prs

2. 列出打开的PR

   pmac listprs

3. 将一些拉取请求合并到它中

   pmac add 5100 5101 5102

   使用与GitHub上相同的拉取请求编号。

   在内部，pmac 使用 git am 来应用来自拉取请求的提交。如果您遇到 git am 冲突，pmac 会通知您。您可以在另一个终端中编辑文件以手动解决冲突。然后执行

   git add FILE
   git commit
   git am --continue

   之后，您可以继续使用 pmac。

4. 完成时，将分支推送到GitHub并创建一个拉取请求。

   pmac 可以帮助编写PR描述

   pmac prmsg

pmac

Usage: pmac [OPTIONS] COMMAND [ARGS]...

  GitHub pull request combiner tool.

  pmac uses a "[tool:paul-mclendahand]" section in setup.cfg to set
  configuration variables. You can override these using PMAC_VARNAME environment
  variables.

  Additionally, if you want to use a GitHub personal access token, you need to
  provide the "PMAC_GITHUB_API_TOKEN" variable in the environment set to the
  token.

  For issues, see: https://github.com/willkg/paul-mclendahand/issues

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  add      Combine specified PRs into this branch.
  listprs  List available PRs for the project.
  prmsg    Print out summary of commits suitable for a PR msg.

pmac listprs

Usage: pmac listprs [OPTIONS]

  List available PRs for the project.

Options:
  --labels / --no-labels  List labels
  --format [table|tab]
  --help                  Show this message and exit.

pmac add

Usage: pmac add [OPTIONS] PR...

  Combine specified PRs into this branch.

Options:
  --help  Show this message and exit.

pmac prmsg

Usage: pmac prmsg [OPTIONS]

  Print out summary of commits suitable for a PR msg.

Options:
  --help  Show this message and exit.