Branching

Publishing a document is fairly straight-forward and completed using the new QuickBuild Github Action. The first step is creating a dedicated branch for the release. For instance, if you're releasing version 2.0 or a document, you should create a new branch called "release-2.0". It's important to include a digit in the branch name, as this is the trigger that tells QuickBuild to create a PDF version of the HTML documents.

Making a dedicated branch ensures that the XML that defines the document is also preserved while allowing it to be modified to account for any changes to the schema (and thus allow it to be used by the automation tools). Running the following script inside the project folder should make the necessary changes

read -p "Enter the version number version" ver
git checkout -b release-$ver
git push --set-upstream origin release-$ver

Updating the PP Dashboard

The PP DashBoard v2.0 is the master view of all the CC documents and their respective versions. To be useful, it should reflect all the documents that are relevant and needs to be updated to when release branches are created. Thankfully, QuickBuild should help you. Once QuickBuild successfully builds (Quickly!), it also creates a mini-dashboard that contains the row that should go into the PP DashBoard. QuickBuild uploads this file (and everything else that it builds) to the gh-pages branch of the PP project in a directory named for the source branch. For example, once you edit any file in the release-4.2.1 branch of operatingsystem QuickBuild pushes all the output files to a directory called release-4.2.1 in the 'gh-pages' branch of the operatinsystem project. The mini-dashboard is called "Minidash.adoc". Click the button labeled 'Raw' and copy all the "long" lines (i.e. those after the line beginning with '8+|' until the line consisting of '|==='). Then edit the PP Dashboard, by finding your project within the AsciiDoc table and paste the contents appropriately. You can also paste this row in the README.adoc in corresponding branch and add it to the row the project's default branches' README.adoc.