Add notes during pipeline execution

This feature allows users to add notes for pipeline execution.

Harness makes pipeline executions easier to understand and find. Add notes to any execution, such as ticket IDs, change requests, or deployment details, and search for executions using those notes.

This helps you capture the context behind every execution and quickly find the runs you need with the new Execution Notes filter.

---

What you will learn from this topic

• How to add notes to pipeline executions while they run or after they complete.

• How to edit notes on existing executions.

• How to filter executions by notes to find specific runs.

---

Before you begin

Ensure the following are in place before you begin:

• Harness account access: You need access to a Harness account with pipelines. Go to Getting started with Harness Platform to create an account.

• Pipeline execution permissions: You need Execute permission on Pipelines to add or edit notes on pipeline executions. To get this permission, an administrator must assign you a role that includes it. Go to RBAC in Harness to understand role-based access control and Manage roles to configure role assignments.

---

Add a note to a pipeline execution

You can add a note to a pipeline execution while it is running and even after the execution is completed.

To add notes for a pipeline after it has completed execution, navigate to the Execution List (history) and click the three-dot menu next to the execution for which you want to add notes, and then select Add Execution Notes.

Alternatively, select an execution and click Add a Note in Pipeline Studio.

---

Edit the note to a pipeline execution

You can update an existing note on a pipeline execution while it is running or after it has completed.

Perform the following steps to edit a note:

1. Go to Execution History and open the execution you want to update.

2. In Pipeline Studio, click View Note.

3. Update the note as needed and save your changes.

---

Filter executions by notes

You can create filters based on text present in execution notes and search across executions using these filters.

This feature requires the CDS_EXECUTION_LIST_FILTERS feature flag. Contact Harness Support to enable it.

In the Add a note to a pipeline execution example, notes were added indicating whether the executed pipeline contained a single stage or multiple stages. This demonstrates how you can use execution notes. You can use any criteria such as ticket number, change request number, deployment details, or pipeline changes to filter execution notes.

The following example shows filtering based on execution notes across multiple runs of a pipeline, where some executions include a single stage while others include two or three stages.

• Using the keyword single

• Using the keyword two

• Using combination of keywords single , two and three

---

Next steps

• View and compare pipeline executions: View compiled YAML and compare execution differences.

• Executions management: Manage queued and running executions across your account.

• Add tags dynamically to execution: Tag pipeline executions for better organization.