Page MenuHomePhabricator

Allow Diviner documentation to be generated with Harbormaster + Drydock
Closed, ResolvedPublic

Description

It would be great if Diviner documentation could be generated by Harbormaster + Drydock.

Event Timeline

joshuaspence raised the priority of this task from to Normal.
joshuaspence updated the task description. (Show Details)
joshuaspence added projects: Diviner, Diffusion.
joshuaspence added subscribers: joshuaspence, epriestley.

I think doing this would require solving many of the problems that Drydock and Harbormaster solve.

For example:

  • How do users configure which branches get documentation generated?
  • How do you keep track of what documentation you've generated, so an older generation task doesn't overwrite it with out-of-date documentation?
  • Are you going to have one working copy on disk, or several?
    • If you have only one, how do you deal with it when new commits arrive more quickly than documentation generates (e.g., several branches generating docs, a new commit arrives every 20 minutes on average, docs take an hour to generate)?
    • If you have more than one, how do you manage locking, allocation, cleanup and reuse?

These questions can all be answered, but I think the answers look a lot like slimmed-down versions of Harbormaster and Drydock.

problems that Drydock and Harbormaster solve

Well, are intended to solve.

Yeah OK... I'll repurpose this

joshuaspence renamed this task from Automatically generate Diviner documentation to Allow Diviner documentation to be generated with Harbourmaster + Drydock.Aug 5 2014, 8:17 AM
joshuaspence updated the task description. (Show Details)
joshuaspence edited projects, added Harbormaster; removed Diffusion.
chad renamed this task from Allow Diviner documentation to be generated with Harbourmaster + Drydock to Allow Diviner documentation to be generated with Harbormaster + Drydock.Oct 9 2014, 9:54 PM
epriestley claimed this task.

I don't think there's anything specifically actionable here. If your build server has direct access to the Phabricator database (it never should) I think we get this for free as soon as "lease host + build working copy + run command" is reliable.

If your build server does not have direct access to the Phabricator database (good), this is T5790 + the above.