Skip to content

DOCOPS-236 Trigger one PDF run per changed docset, using the docs-template workflows - #532

Open
recrwplay wants to merge 1 commit into
devfrom
docops-236-publish-several-pdfs
Open

recrwplay wants to merge 1 commit into
devfrom
docops-236-publish-several-pdfs

Conversation

@recrwplay

Copy link
Copy Markdown
Contributor

Why

docs-drivers builds a PDF for each of its five driver docsets (java-manual, python-manual, go-manual, dotnet-manual, javascript-manual) but had no PDF workflow and no trigger. DOCOPS-236 makes the PDF build produce one PDF per run, so each can be published by docs-publish.

What changed

Copied from docs-template, so this repository has the standard shape:

  • docs-trigger-builds.yml (new): starts on a push to 4.4, 5.x, 6.x or dev. Sets pdf-docsets: true and pdf-shared-paths: common-content, so a push starts one PDF run for each docset whose folder it changes. A change in common-content, or in a path that no docset claims, builds all five. A manual run can pick one docset or all.
  • docs-generate-pdf.yml (new): builds the PDF of the one docset in docset-path and sends it to docs-publish.
  • docs-generate-html.yml (replaced): no longer starts itself on push. The trigger starts it, and gets dev and prod from the branch record in docs-publish (dev -> dev, prod -> 6.x) instead of the DEV_BRANCH and PROD_BRANCH values that were hardcoded here.

Check before merging

Testing

A real build of java-manual with the pdf-generator from the docs-tools PR gave one PDF, java-manual-6.pdf, built from java-manual and common-content only, with no warnings or errors in the Antora log.

…plate workflows

docs-drivers builds a PDF for each of its five driver docsets, but had no PDF workflow and no trigger. This copies docs-trigger-builds.yml, docs-generate-html.yml and docs-generate-pdf.yml from docs-template, so builds are started by the trigger, which reads the dev and prod branch from the branch record in docs-publish (dev -> dev, prod -> 6.x) instead of the hardcoded branch names in the old HTML workflow.

The trigger sets pdf-docsets and pdf-shared-paths: common-content, so a push starts one docs-generate-pdf.yml run for each docset whose folder it changes. A change in common-content, or in a path that no docset claims, builds all five. A manual run of the trigger can pick one docset or all.

Needs the next docs-tools release (the inputs are new) and the v2 tag moved to it before this is merged.
@neo4j-docops-agent

Copy link
Copy Markdown
Collaborator

This PR includes documentation updates
View the updated docs at https://neo4j-docs-drivers-532.surge.sh

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants