Skip to content
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.

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

Add step name to message #816

Merged

Conversation

SaschaSchwarze0
Copy link
Member

Changes

For our downstream service, we provide troubleshooting documentation for the user to determine the root cause of a failure. We there separate failures by step name. Since we rewrote the BuildRun message to not anymore contain the TaskRun reason, the step name is only shown at the end of the message in the kubectl logs command while we include the pod name earlier as well. I am slightly making a message change to also include the name of the step at the beginning of the message and not just in the kubectl logs example which makes it easier to understand and extract the relevant data.

Submitter Checklist

  • Includes tests if functionality changed/was added
  • Includes docs if changes are user-facing
  • Set a kind label on this PR
  • Release notes block has been filled in, or marked NONE

Release Notes

The message field of the Succeeded condition of a failed BuildRun now includes the name of the step that has failed

@openshift-ci openshift-ci bot added the release-note Label for when a PR has specified a release note label Jun 22, 2021
@openshift-ci openshift-ci bot requested review from imjasonh and sbose78 June 22, 2021 15:24
@SaschaSchwarze0 SaschaSchwarze0 added the kind/feature Categorizes issue or PR as related to a new feature. label Jun 22, 2021
Copy link
Contributor

@qu1queee qu1queee left a comment

Choose a reason for hiding this comment

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

Thanks. Important to highlight that we have the Status.failedAt object which contains a pod and a container fields, to provide this type of information. Extending the msg is fine for me.

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jun 22, 2021
@gabemontero
Copy link
Member

/approve

@openshift-ci
Copy link
Contributor

openshift-ci bot commented Jun 22, 2021

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: gabemontero

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 22, 2021
@openshift-merge-robot openshift-merge-robot merged commit 8f5d46b into shipwright-io:main Jun 22, 2021
@SaschaSchwarze0 SaschaSchwarze0 deleted the sascha-step-name branch June 24, 2021 08:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/feature Categorizes issue or PR as related to a new feature. lgtm Indicates that a PR is ready to be merged. release-note Label for when a PR has specified a release note
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants