diff --git a/docs/source/cli/github.rst b/docs/source/cli/github.rst index 5e0667be2..a077c5444 100644 --- a/docs/source/cli/github.rst +++ b/docs/source/cli/github.rst @@ -8,7 +8,7 @@ github git machete github -where ```` is one of: ``anno-prs``, ``checkout-prs``, ``create-pr``, ``retarget-pr`` or ``restack-pr``. +where ```` is one of: ``anno-prs``, ``checkout-prs``, ``create-pr``, ``retarget-pr``, ``restack-pr`` or ``update-pr-descriptions``. Creates, checks out and manages GitHub PRs while keeping them reflected in branch layout file. @@ -83,7 +83,7 @@ Creates, checks out and manages GitHub PRs while keeping them reflected in branc If ``.git/info/milestone`` file is present, its contents (a single number --- milestone id) are used as milestone. If ``.git/info/reviewers`` file is present, its contents (one GitHub login per line) are used to set reviewers. - The subject of the first unique commit of the branch is used as PR title. + Unless ``--title`` is provided, the subject of the first unique commit of the branch is used as PR title. If ``.git/info/description`` or ``.github/pull_request_template.md`` template is present, its contents are used as PR description. Otherwise (or if ``machete.github.forceDescriptionFromCommitMessage`` is set), PR description is taken from message body of the first unique commit of the branch. @@ -135,6 +135,22 @@ Creates, checks out and manages GitHub PRs while keeping them reflected in branc #. deletes unmanaged branches, #. deletes untracked managed branches that have no downstream branch. +``update-pr-descriptions``: + + Updates the generated sections ("intro") of PR descriptions that lists the upstream and/or downstream PRs + (depending on ``machete.github.prDescriptionIntroStyle`` git config key). + + **Options:** + + --all Update PR descriptions for all PRs in the repository. + + --downstream Update PR descriptions for all PRs that are downstream of the PR for the current branch. + + --mine Update PR descriptions for all PRs opened by the current user associated with the GitHub token. + + --related Update PR descriptions for all PRs that are downstream or upstream of the PR for the current branch. + Use when ``machete.github.prDescriptionIntroStyle`` is ``full`. + **Git config keys:** ``machete.github.{domain,remote,organization,repository}`` (all subcommands):