Skip to main content

Pipeline Status

Each pipeline is assigned a status to help users efficiently monitor and manage documentation runs. This status is prominently displayed next to each item in the Pipelines view of your Komment dashboard.

As pipelines progress through various stages, their statuses update dynamically, providing real-time visibility and state tracking to users.

Pipeline status

Status Codes​

The following list outlines possible pipeline statuses and explains what each indicates:

SCHEDULED:

Pipelines set to run within the next 24 hours.

The pipeline will kick off automatically at the time indicated in the 'Start' column. To adjust the frequency, target and other configurations of scheduled runs, refer to the Repositories view.

QUEUED:

Pipelines waiting to be picked up by a worker process. The duration a pipeline remains queued depends on:

  • The volume of traffic and demand on our servers
  • Your subscription plan — higher tiers get priority in the queue
  • The number of concurrent pipelines running for a given user

RUNNING:

Pipelines actively being processed and documented by Komment. You can monitor a running pipeline's progress in real time by opening its details, which provide a dynamically updated breakdown of the code being documented.

STOPPED:

Pipelines that were manually interrupted by the user during processing. Documentation from stopped pipelines doesn't appear in Knowledge Hub nor gets pushed to the git repository.

COMPLETED:

Pipelines that have finished documenting all relevant items in the repository.

The documentation output is accessible in Knowledge Hub immediately after a pipeline has completed. In-code comments are available as a Pull Request issued against the target branch.

SKIPPED:

Pipelines that correspond to code where no documentable items are detected. This can occur for several reasons:

  • All items in the pipeline have already been documented. You can configure Komment to overwrite existing documentation in Repository Configuration.
  • You've exceeded the monthly usage allowed under your current subscription.
  • Your code is written in a language not currently supported by Komment.

FAILED:

Komment encountered an unexpected error while processing the code. This can occur for several reasons:

  • A bug in our system—we encourage you to file a bug report.
  • GitHub API experiencing downtime. Check the most current status here.
  • User deleted resources generated by Komment in the git repository during pipeline execution.