pipe-cd / pipe-cd/pipecd

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

Open
#7,376 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
1.4k
Forks
364
Avg merge
1d 4h
Merged PRs (30d)
84

Description

What would you like to be added:
A status_reason field to the Command protobuf message to store the reason for a command failure.

Why is this needed:
Currently, when a command fails, its status is updated to COMMAND_FAILED but there is no dedicated field to record exactly why it failed. This makes debugging difficult for users. Adding a status_reason field will resolve the TODO in pkg/model/command.proto and provide better error tracking.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the TODO in pkg/model/command.proto and inspect the Command message and the code that updates a command to COMMAND_FAILED. Trace how command status data is generated and stored. Done means the Command model has a status_reason field and failed commands retain the reason that caused the failure.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
devops
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.