Overview
Overview
Users can view a list of all their past processes on the Pipelines view of their Komment dashboard.
A pipeline is a unique documentation run, triggered either manually via QuickStart or automatically by Komment as part of a Scheduled Run.
Pipelines allow users to monitor the status of all completed Komment jobs and view various metrics on the volume, target, and results of the processed code.
Automatic Access Synchronization: Pipelines are automatically synchronized with a users' access to organizations and repositories on the source Git platform. Users will see all runs associated with repos they have permissions to, even if the runs occurred before they joined the repository. If an admin revokes a user's access, any pipelines corresponding to that repository will no longer be visible to that user in their Komment dashboard.
(1) Users can navigate to older pipelines using the page controls. This component also displays the total number of pipelines a user has currently has access to.
(2) Users can sort pipelines in ascending or descending order by clicking the arrows next to a property heading.
By default, the Pipelines view displays the 100 most recent pipelines for users.
Properties
(1) ID: Unique identifier of a pipeline. Used for internal tracking and database relationships.
(2) Type: Indicates whether a pipeline was triggered manually through QuickStart or automatically by Komment as part of a scheduled run.
(3) Repository: Name of the Git repository and the specific branch on which the pipeline ran.
(4) Status: The current state of the pipeline, which updates in real time to allow users to track pipeline progress.
See Pipeline Status for detailed explanations of the different pipeline statuses.
(5) Items: The ratio of documented items to total ingested items.
An item is a code construct or arbitrary pocket of complexity that Komment identifies appropriate for documentation. This could be a class, method, a particularly complex sub-query, modules, or even an entire library.
(6) Start: The time when a pipeline was picked up by a worker for processing or, for scheduled pipelines, the expected time of execution.
(7) Duration: The total time taken for a pipeline to complete its run.
Actions
The action buttons provide users with a convenient way to quickly manage and control their pipeline operations.
(1) Stop: Allows users to halt a pipeline that is currently running.
(2) More/Less: Toggle details for additional information and metrics about the run.
(3) Rerun: Triggers a new run with the same set of files as the selected pipeline.