Fixes #73 CI/CD: Write release GH Action: publish docs

[fdrozdowski]

Pull request checklist

Please check if your PR fulfills the following requirements:

• Tests for the changes have been added (for bug fixes / features)
• Docs have been reviewed and added / updated if needed (for bug fixes / features)
• Build was run locally and any changes were pushed
• Lint has passed locally and any fixes were made for failures

Pull request type

Please check the type of change your PR introduces:

• Bugfix
• Feature
• Code style update (formatting, renaming)
• Refactoring (no functional changes, no api changes)
• Build related changes
• Documentation content changes
• Other (please describe):

GitHub action for building and publishing documentation to GitHub Pages.

What is the current behavior?

Currently, we have to check out the latest documentation branch, build the documentation, and publish the static contents to the gh-pages branch.

What is the new behavior?

We introduce a new GitHub workflow that is kicked off on any docs/* branch if docs/* path has been modified and if a docs/* branch is created. The workflow checks if the branch it's running on is the latest documentation branch (docs/x.y.z where x.y.z is the highest available version). If that check passes, we install pipenv, install the dependencies for building documentation, build the documentation, and publish the static contents to the gh-pages branch.

The reason we only want to run the workflow on the latest docs branch is because we only have one publishing context. We can only publish one version of the documentation using GitHub pages so we only publish the latest version.

You can see a preview of commits created by this workflow under https://github.com/fdrozdowski/virtualization-sdk/tree/gh-pages. They are all entitled " Deploy to gh-pages 🚀 ".

Does this introduce a breaking change?

• Yes
• No

Other information

[ankursarin]

looks great! thanks for setting this up