Skip to main content

Pipelines

My pipeline keeps getting SKIPPED.​

Pipelines are typically skipped for the following reasons:

  • No code changes detected since the last documentation run
  • Code changes since last run didn't result in new documentable items
  • You've exceeded the monthly usage allowed under your current plan
  • Your code is written in a language not currently supported by Komment

To understand why a specific pipeline was skipped, check its logs for detailed information.

My pipeline FAILED before completion.​

Pipeline failures occur when Komment encounters unexpected errors during code processing. Common reasons include:

  • Users deleting Komment-generated resources in the git repository while a pipeline is running.
  • GitHub API experiencing downtime. You can check its current status here.
  • A bug in our system — help us improve Komment by filing a bug report.

To understand why a specific pipeline failed, check its logs for detailed information.

My pipeline is stuck in a RUNNING state.​

Large codebases take longer to document, especially if it's Komment's first time analyzing them. Your pipeline might also experience delays during high-demand periods, particularly if you're on the free Plan.

You can always track Komment's real-time progress for any pipeline by checking the Pipeline details. If the real-time statistics aren't updating, try manually interrupting the pipeline and restarting the run.