Automated Runs

---

Automated runs is a way to set your wikis up for continuous updates at a set schedule. This keeps your wiki in sync with changes in your project, ensuring the information is consistently reliable and up to date.

When automated runs are enabled for a project Pipelines will run at your pre-selected time and frequency — called a schedule — and automatically update your wiki.

There is no limit to the number of wikis that you can enable automated runs for.

Setup

1. Ensure that the project you want to enable automated runs for is connected and listed in your Library.

2. Click on the dropdown menu icon on the wiki card to open up wiki options, and click on the calendar icon. If you cannot click on the icon, you may not have the correct permissions and will need to ask the project owner to provide admin access or to enable automated runs.

3. Toggle on Automatic Updates in the modal that opens. This will apply a default schedule of daily updates at 3 AM. You can freely configure the update schedule for each wiki if the default schedule is not appropriate for your needs.

Komment will now keep your project continuously documented without requiring any actions from you or your team 😌

Workflow

1. The Pipelines panel displays the next set of pipelines scheduled to run for your wikis.

Once a pipeline has been scheduled, it will automatically start at the specified time. If you wish to skip a scheduled run, simply click the Stop icon in Pipeline Actions for the specific entry.

2. Documentation jobs will initiate at their scheduled time, and their status will switch to RUNNING.

For the first pipeline in a repository, the job may take longer than usual as the system maps your project's structure. Subsequent pipelines will only document changes by calculating the code delta, making them run much faster.

3. Keep track of all your past, present, and future runs in the Pipelines panel.

You can click on any entry in the list to see Pipeline Details. This view lets you monitor pipeline progress and easily access the wiki generated by a Pipeline through the split view.

4. The Wiki of a project provides you with all updated documentation for your codebase including visual diagrams, example snippets and high-level feature descriptions.

5. You can also access your wiki through clicking on it in the Wiki Library — the Logs and Pipeline views are simply an additional layer of information if you need it.