Skip to content

ADD userguide/managingApp/deployment-trace #6413

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rahulshendre wants to merge 3 commits into
base: master
Choose a base branch
from
Open

ADD userguide/managingApp/deployment-trace #6413

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a7ad635
readability improvements
rahulshendre Jan 8, 2026
41cac5e
page revamp
rahulshendre Jan 12, 2026
ba4c012
revise deployment-trace.md
eeshaanSA Jan 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 12 additions & 11 deletions docs/content/en/docs-v1.0.x/user-guide/managing-application/deployment-trace.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,37 +1,38 @@
---
title: "Better connect between CI and CD with Deployment Trace"
title: "Deployment Trace"
linkTitle: "Deployment Trace"
weight: 992
description: >
A helper fulfill the gap between CI and CD.
Understand the deployment trace feature and how you can link application commits to the deployments they trigger.
---

You are a developer who works with application code change, and don't know what deployment is triggered by your commit on PipeCD UI? This feature is for you.
Deployment Trace links application code changes to the resulting deployments that reflect those code changes in the PipeCD Web UI.

If you're using PipeCD [Event Watcher](./event-watcher) to trigger the deployment for your code change, you can attach information of the triggered commit as the event data, PipeCD will use that information and helps you to make a link between your application code commit and the triggered deployments that reflect your code change.
When using PipeCD [Event Watcher](./event-watcher) to trigger deployments, you can attach commit information as event data. PipeCD uses that information to create links between your application code commits and the triggered deployments.

![Deployment Trace feature](/images/deployment-trace-ui.png)

## Usage

Via `pipectl event register` command
Use the `pipectl event register` command:

```bash
Usage:
pipectl event register [flags]
```

Flags:

```
--commit-author string The author of commit that triggers the event.
--commit-hash string The commit hash that triggers the event.
--commit-message string The message of commit that triggers the event.
--commit-message string The commit message that triggers the event.
--commit-timestamp int The timestamp of commit that triggers the event.
--commit-title string The title of commit that triggers the event.
--commit-url string The URL of commit that triggers the event.
```

Note: You have to attach at least `commit-hash` and `commit-url` as the event data in order to use the Deployment Trace feature.
>**Note:** Attach at least `commit-hash` and `commit-url` as event data to use the Deployment Trace feature.

## Github Actions
## GitHub Actions

If you're using Github Actions in your CI workflow, [actions-event-register](https://github.com/marketplace/actions/pipecd-register-event) is for you!
With it, you can easily register events without any installation.
If you are using GitHub Actions in your CI workflow, use [actions-event-register](https://github.com/marketplace/actions/pipecd-register-event) to register events without any installation.