SteeltoeOSS / Documentation

The documentation, api browser, and getting started guides used for the Steeltoe's website.
Apache License 2.0
8 stars 23 forks source link

Steamline pipeline #248

Closed ccheetham closed 2 years ago

ccheetham commented 2 years ago

Splits pipeline into 3 pipelines:

The "docfx" pipeline creates an image based on the official Mono Docker image and adds docfx from the DocFX project. Additionally added are the utilities: git, wget, and unzip.

The "docfx" pipeline image name format is steeltoe.azurecr.io/docfx:<version>-<rev> where <version> is the docfx distribution version and <rev> is a unique ID determined by Azure DevOps.

Sample image name: steeltoe.azurecr.io/docfx:2.57.2-11

The "metadata" pipeline creates an image based on a "docfx" pipeline image. It adds source documentation metadata for the 2.x and main branches. More specifically, it uses tags from those branches. The metadata is isolated into its own pipeline because those tags change infrequently and the metadata generation takes on the order of 5 minutes.

The "metadata" pipeline image name format is steeltoe.azurecr.io/documentation-metadata:<main-tag>-<2.x-tag>-<rev> where <main-tag> and <2.x-tag> are tags from the repo and <rev> is a unique ID determined by Azure DevOps.

Sample image name: steeltoe.azurecr.io/documentation-metadata:3.1.3-2.5.4-1

The "documentation" component is the original pipeline minus the above components. It uses the "metadata" pipeline image as a cache of sorts to get the source metadata.