llvm/docs/GitHub.rst

   1 ======================
   2 LLVM GitHub User Guide
   3 ======================
   4
   5 Introduction
   6 ============
   7 The LLVM Project uses `GitHub <https://github.com/>`_ for
   8 `Source Code <https://github.com/llvm/llvm-project>`_,
   9 `Releases <https://github.com/llvm/llvm-project/releases>`_, and
  10 `Issue Tracking <https://github.com/llvm/llvm-project/issues>`_.
  11
  12 This page describes how the LLVM Project users and developers can
  13 participate in the project using GitHub.
  14
  15 Releases
  16 ========
  17
  18 Backporting Fixes to the Release Branches
  19 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  20 You can use special comments on issues to make backport requests for the
  21 release branches.  This is done by making a comment containing one of the
  22 following commands on any issue that has been added to one of the "X.Y.Z Release"
  23 milestones.
  24
  25 ::
  26
  27   /cherry-pick <commit> <commit> <...>
  28
  29 This command takes one or more git commit hashes as arguments and will attempt
  30 to cherry-pick the commit(s) to the release branch.  If the commit(s) fail to
  31 apply cleanly, then a comment with a link to the failing job will be added to
  32 the issue.  If the commit(s) do apply cleanly, then a pull request will
  33 be created with the specified commits.
  34
  35 ::
  36
  37   /branch <owner>/<repo>/<branch>
  38
  39 This command will create a pull request against the latest release branch using
  40 the <branch> from the <owner>/<repo> repository.  <branch> cannot contain any
  41 forward slash '/' characters.