Repository navigation
Conversation
…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.
Collaborator
|
This PR includes documentation updates |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 to4.4,5.x,6.xordev. Setspdf-docsets: trueandpdf-shared-paths: common-content, so a push starts one PDF run for each docset whose folder it changes. A change incommon-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 indocset-pathand 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 theDEV_BRANCHandPROD_BRANCHvalues that were hardcoded here.Check before merging
v2has moved to it. The new inputs come from DOCOPS-236 Build one PDF per docset, only for the docsets a push changed (pdf-generator 0.2.0) docs-tools#183.4.4and5.xnow build PDFs as well, from those branches, like the HTML. Before, no PDF was built here.devand6.x.Testing
A real build of
java-manualwith the pdf-generator from the docs-tools PR gave one PDF,java-manual-6.pdf, built fromjava-manualandcommon-contentonly, with no warnings or errors in the Antora log.