Skip to content

Build deliverables #12

@tomschr

Description

@tomschr

Situation

We want to build deliverables from DocBook or ADoc sources to be published on d.s.c.

Use Case

As a user, when I request a build of a specific project or the whole set, it performs several steps to create the output formats with the index pages in the target directory.

Possible Implementation

The script perform several steps:

  1. Read the XML Docserv config and stitch them together. Maybe store the result in a cache directory.
  2. Determine the set of deliverables.
  3. Iterate over it in a concurrent way.
  4. Determine the repository of the deliverable. If there is no repo inside the permanent-full directory, clone it.
  5. Clone a temporary repo from the permanent-full directory.
  6. Create a temporary directory as the result directory, but use the temporary repo as a source.
  7. If the build was successful, create the metadata. This could also be done prior to building the target formats.
  8. Collect the metadata from the deliverable and other resources.
  9. Create an intermediate JSON structure and pass it to Gayathri's Jinja templates.
  10. Store the result in the temporary directory.
  11. If everything was successful, sync it to the target directory ready for the final publishing step.

Sub-issues

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions