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

[FEATURE] Improved Error Messaging for Nonexistent Namespaces in Shipwright CLI #244

Closed
1 task done
jitendar-singh opened this issue Mar 27, 2024 · 5 comments · Fixed by #278
Closed
1 task done
Assignees
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/feature Categorizes issue or PR as related to a new feature.

Comments

@jitendar-singh
Copy link

Is there an existing feature request for this?

  • I have searched the existing feature requests

Is your feature request related to a problem or use-case? Please describe.

Currently, when a user specifies a namespace that either doesn't exist or lacks builds/build runs, the CLI returns only the field headers without any contextual message. This can lead to confusion and frustration for users who are expecting feedback regarding the absence of builds or build runs in the specified namespace.

Describe the solution that you would like.

To enhance the user experience and provide clearer feedback, I would like to propose the implementation of descriptive error messages in such scenarios. For example:

  • If the specified namespace does not exist:
    "Error: Namespace 'xyz' not found. Please ensure that the namespace exists and try again."

  • If the specified namespace exists but contains no builds:
    "No builds found in namespace 'xyz'. Please initiate a build or verify the namespace."

  • If the specified namespace exists but contains no build runs:
    "No build runs found in namespace 'xyz'. Please start a build run or check the namespace."

Describe alternatives you have considered.

No response

Anything else?

jitsingh@jitsingh-mac  ~/Downloads  shp build list -n builds-example (This project doesnt exist)
NAME	OUTPUT	STATUS
 jitsingh@jitsingh-mac  ~/Downloads  shp build list -n build-examples
NAME			OUTPUT										STATUS
buildah-golang-build	quay.io/sunnyconcise/shipwright-example:latest					all validations succeeded
s2i-nodejs-build	image-registry.openshift-image-registry.svc:5000/build-examples/nodejs-ex	all validations succeeded

jitsingh@jitsingh-mac  ~/Downloads  shp buildrun list -n build-examples
NAME				STATUS		AGE
buildah-golang-buildrun		Succeeded	1d
s2i-nodejs-buildrun		Succeeded	1d

 jitsingh@jitsingh-mac  ~/Downloads  shp buildrun list -n build-example ((This project doesnt exist)
NAME	STATUS	AGE
@jitendar-singh jitendar-singh added the kind/feature Categorizes issue or PR as related to a new feature. label Mar 27, 2024
@jitendar-singh jitendar-singh changed the title [FEATURE] <Improved Error Messaging for Nonexistent Namespaces in Shipwright CLI> [FEATURE] Improved Error Messaging for Nonexistent Namespaces in Shipwright CLI Mar 27, 2024
@qu1queee qu1queee added this to the release-v0.14.0 milestone Apr 4, 2024
@qu1queee qu1queee added the help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. label May 16, 2024
@qu1queee qu1queee added the good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. label Aug 22, 2024
@qu1queee
Copy link
Contributor

qu1queee commented Sep 5, 2024

Discussed during refinement, we will look for help in Slack or similar.

@Adarsh-jaiss
Copy link
Member

Hey @qu1queee , I would love to work on this issue

@Adarsh-jaiss
Copy link
Member

/assign

@Adarsh-jaiss
Copy link
Member

  • Hey @qu1queee , while fixing the bug, i'm not able to find the shipwright API for fetching the namespaces. Can you please help me out on this

@Adarsh-jaiss
Copy link
Member

hey @qu1queee, here's the PR. please review it!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/feature Categorizes issue or PR as related to a new feature.
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants