https://bugzilla.wikimedia.org/show_bug.cgi?id=72454

--- Comment #4 from Antoine "hashar" Musso (WMF) <has...@free.fr> ---
(In reply to James Forrester from comment #3)
> Does this now need a jenkins config change?

Definitely :-)


I wrote an overview of the architecture we are using to generate documentation
on slave and have them ultimately published to doc.wikimedia.org. It has a very
simple job template example:
https://www.mediawiki.org/wiki/Continuous_integration/Documentation_generation

Some additional guidelines:

* the job should be run on Trusty slaves using:

   node: contintLabsSlave && UbuntuTrusty

* use the zuul-cloner to clone the repository (see jjb/macro-scm.yaml) should
be as simple as:

   builders:
    - zuul-cloner:
        projects: "oojs/ui"

  The clone is made under $WORKSPACE/src/$ZUUL_PROJECT so the doxygen builder
would be:

   - shell: |
      cd src/$ZUUL_PROJECT
      doxygen

* the output destination is defined in the Doxyfile. We could parse the file to
figure it out but it is probably easier to just hardcode it for now:

  - push-doc:
    docsrc: 'src/oojs/ui/docs/php'  # path in the workspace
    docdest: 'oojs-ui/php'  # destination under doc.wikimedia.org


A few culprits:

* there is already some jsduck documentation published, probably want to
namespace the path based on the language (php / js).
* we do not have a shell helper yet to easily namespace by git branch / tag.
IIRC there is some logic around hardcoded in the jsduck macro for it.


Later on we can refactor the resulting job template to make it reusable by
other projects as well.

-- 
You are receiving this mail because:
You are on the CC list for the bug.
_______________________________________________
Wikibugs-l mailing list
Wikibugs-l@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/wikibugs-l

Reply via email to