src/docs/user/userguide/drydock_repository_automation.diviner

   1 @title Drydock User Guide: Repository Automation
   2 @group userguide
   3
   4 Configuring repository automation so Phabricator can push commits.
   5
   6
   7 Overview
   8 ========
   9
  10 IMPORTANT: This feature is very new and some of the capabilities described
  11 in this document are not yet available. This feature as a whole is a prototype.
  12
  13 By configuring Drydock and Diffusion appropriately, you can enable **Repository
  14 Automation** for a repository. This will allow Phabricator to make changes
  15 to the repository.
  16
  17
  18 Limitations
  19 ===========
  20
  21   - This feature is a prototype.
  22   - Only Git is supported.
  23
  24
  25 Security
  26 ========
  27
  28 Configuring repository automation amounts to telling Phabricator where it
  29 should perform working copy operations (like merges, cherry-picks and pushes)
  30 when doing writes.
  31
  32 Depending on how stringent you are about change control, you may want to
  33 make sure these processes are isolated and can not be tampered with. If you
  34 run tests and automation on the same hardware, tests may be able to interfere
  35 with automation. You can read more about this in
  36 @{article:Drydock User Guide: Security}.
  37
  38
  39 Configuring Automation
  40 ======================
  41
  42 To configure automation, use {nav Edit Repository > Edit Automation} from
  43 Diffusion.
  44
  45 On the configuration screen, specify one or more working copy blueprints in
  46 Drydock (usually, you'll just use one). Repository automation will use working
  47 copies built by these blueprints to perform merges and push changes.
  48
  49 For more details on configuring these blueprints, see
  50 @{article:Drydock Blueprints: Working Copies}.
  51
  52 After selecting one or more blueprints, make sure you authorize the repository
  53 to use them. Automation operations won't be able to proceed until you do. The
  54 UI will remind you if you have unauthorized blueprints selected.
  55
  56
  57 Testing Configuration
  58 =====================
  59
  60 Once the blueprints are configured and authorized, use {nav Test Configuration}
  61 to check that things are configured correctly. This will build a working copy
  62 in Drydock, connect to it, and run a trivial command (like `git status`) to
  63 make sure things work.
  64
  65 If it's the first time you're doing this, it may take a few moments since it
  66 will need to clone a fresh working copy.
  67
  68 If the test is successful, your configuration is generally in good shape. If
  69 not, it should give you more details about what went wrong.
  70
  71 Since the test doesn't actually do a push, it's possible that you may have
  72 everything configured properly //except// write access. In this case, you'll
  73 run into a permission error when you try to actually perform a merge or other
  74 similar write. If you do, adjust permissions or credentials appropriately so
  75 the working copy can be pushed from.
  76
  77
  78 Next Steps
  79 ==========
  80
  81 Continue by:
  82
  83   - understanding Drydock security concerns with
  84     @{article:Drydock User Guide: Security}; or
  85   - returning to the @{article:Drydock User Guide}.