Skip to content

Metadata Analyzer

Analyze, document, and publish metadata. The action walks a project folder for pipelines (*.hpl), runs Hop’s impact analysis on each one, and writes a documentation tree describing which tables and fields every pipeline reads and writes — with field-to-source tracing per output table. Output is HTML or Markdown.

OptionDescription
Source folder (pipelines)Root folder scanned for *.hpl files.
Output folderWhere the documentation is written.
Output formatHTML or Markdown.
Include sub-foldersScan sub-folders recursively.

For each pipeline the action writes one document at the output root, named after the pipeline, listing every output table. Each output table also gets its own detail document under the table/ sub-folder. Recognized output transforms are Bulk Loader, Staging Upsert, and Table Output.

Every written column is documented with four columns:

ColumnMeaning
FieldThe column written to the output table.
ExpressionThe source field or expression it comes from.
SourceWhere the value originates. When the column comes from a database lookup, this is a link to the looked-up (for example dimension) table’s document; otherwise it is the source table or the transform name as plain text.
TypeThe column data type.

When a pipeline has a description, the action shows it as the pipeline’s main source table at the top of the document. Set the pipeline description to the main source table name to make it appear.