Skip to content

Enhancement: Add status_reason field to Command message - #7377

Open
Rucha0901 wants to merge 1 commit into
pipe-cd:masterfrom
Rucha0901:add-command-failure-reason
Open

Enhancement: Add status_reason field to Command message#7377
Rucha0901 wants to merge 1 commit into
pipe-cd:masterfrom
Rucha0901:add-command-failure-reason

Conversation

@Rucha0901

Copy link
Copy Markdown

What this PR does:
Adds a status_reason field to the Command protobuf message and regenerates the go code.

Why we need it:
To record the exact reason why a command failed, resolving a TODO in pkg/model/command.proto.

Which issue(s) this PR fixes:

Fixes #7376

Does this PR introduce a user-facing change?:

  • How are users affected by this change: Better debugging information when commands fail.
  • Is this breaking change: No.
  • How to migrate (if breaking change): N/A

Screenshots/Videos (for documentation or website changes):
N/A

Signed-off-by: Rucha0901 <imt_2025071@iiitm.ac.in>
Copilot AI lite review requested due to automatic review settings September 12, 2026 13:27
@Rucha0901
Rucha0901 requested review from a team as code owners September 12, 2026 13:27
@netlify

netlify Bot commented Sep 12, 2026

Copy link
Copy Markdown

Deploy Preview for pipecd-site canceled.

Name Link
🔨 Latest commit 6d60ccf
🔍 Latest deploy log https://app.netlify.com/projects/pipecd-site/deploys/6aa553508b63af0008634341

@github-actions

Copy link
Copy Markdown
Contributor

👋 Hi @Rucha0901, welcome to PipeCD and thanks for opening your first pull request!

We’re really happy to have you here

Before your PR gets merged, please check a few important things below.


Helpful resources


DCO Sign-off

All commits must include a Signed-off-by line to comply with the Developer Certificate of Origin (DCO).

In case you forget to sign-off your commit(s), follow these steps:

For the last commit:

git commit --amend --signoff
git push --force-with-lease

For multiple commits:

git rebase --signoff origin/master
git push --force-with-lease

Run checks locally

Before pushing updates, please run:

make check

This runs the same checks as CI and helps catch issues early.


💬 Need help?

If anything is unclear, feel free to ask in this PR or join us on the CNCF Slack in the #pipecd channel.
You can get your Slack invite from: https://communityinviter.com/apps/cloud-native/cncf

Thanks for contributing to PipeCD! ❤️

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

Failure reasons are not wired through reporting and command-store updates.

Get a fresh assessment by requesting another Copilot review.

Pull request overview

Adds status_reason to the Command protobuf and regenerates Go and web bindings. The field is not yet propagated through reporting and storage, so failed-command reasons remain empty.

Changes:

  • Adds field 23 to Command.
  • Regenerates Go protobuf and validation code.
  • Regenerates JavaScript and TypeScript bindings.
File summaries
File Summary
web/model/command_pb.js Regenerated JavaScript bindings.
web/model/command_pb.d.ts Regenerated TypeScript definitions.
pkg/model/command.proto Adds status_reason.
pkg/model/command.pb.validate.go Regenerated validation code.
pkg/model/command.pb.go Regenerated Go protobuf bindings.
Review details

Files not reviewed (2)

  • pkg/model/command.pb.go: Generated file
  • pkg/model/command.pb.validate.go: Generated file
  • Files reviewed: 2/5 changed files
  • Comments generated: 1
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread pkg/model/command.proto
map<string,string> metadata = 21;
int64 handled_at = 22 [(validate.rules).int64.gte = 0];
// TODO: Add a new field to show why command was failed.
string status_reason = 23;
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Enhancement: Add a field to store the failure reason for Commands

2 participants