A GitHub Actions Pipeline to Generate OpenAPI Documentation
Introduction This is my first post on GitHub Actions (GHA), the pipeline part of GitHub (GH), and GitHub Pages (GHP), the static hosting service. I will give an example of a pipeline I built for producing documentation for an OpenAPI spec. Seasoned devops/platform engineering people will probably find this very basic, but I hope it can have interest to someone who is starting to play with GHA! I chose the GitHub products because, essentially, they are available for free, and yet are very powerful. Desired Functionality I would like to: Produce HTML documentation from an OpenAPI specification located in some URL, or from a local file, and make it available somewhere Store each HTML version of the specification independently, e.g., one file for version 1.0.0, another one for 1.0.1, etc Have a template for the documentation, with the ability to add additional contents - header, footer - optionally, as well as insert custom JavaScript and CSS Have the generation run on demand Be abl...