Updates the error output for an empty directory #5610
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for odo-docusaurus-preview canceled.
|
cdrage
force-pushed
the
improve-error-output-for-empty-dir
branch
from
6b502d0 to
90c5bca
Compare
<!-- Thank you for opening a PR! Here are some things you need to know before submitting: 1. Please read our developer guideline: https://github.com/redhat-developer/odo/wiki/Dev:-odo-Dev-Guidelines 2. Label this PR accordingly with the '/kind' line 3. Ensure you have written and ran the appropriate tests: https://github.com/redhat-developer/odo/wiki/Dev:-Writing-and-running-tests 4. Read how we approve and LGTM each PR: https://github.com/redhat-developer/odo/wiki/Pull-Requests:-Review-guideline Documentation: If you are pushing a change to documentation, please read: https://github.com/redhat-developer/odo/wiki/Documentation:-Contributing --> **What type of PR is this:** <!-- Add one of the following kinds: /kind bug /kind feature /kind cleanup /kind tests /kind documentation Feel free to use other [labels](https://github.com/redhat-developer/odo/labels) as needed. However one of the above labels must be present or the PR will not be reviewed. This instruction is for reviewers as well. --> **What does this PR do / why we need it:** Updates the error output for running `odo dev` or `odo deploy` in an empty directory. Telling the user to run the same command in a non-empty dir, OR use `odo init`. **Which issue(s) this PR fixes:** <!-- Specifying the issue will automatically close it when this PR is merged --> N/A **PR acceptance criteria:** - [X] Unit test - [X] Integration test - [X] Documentation **How to test changes / Special notes to the reviewer:** Signed-off-by: Charlie Drage <[email protected]>
cdrage
force-pushed
the
improve-error-output-for-empty-dir
branch
from
90c5bca to
46e8072
Compare
|
Kudos, SonarCloud Quality Gate passed!
|
valaparthvi
reviewed
Mar 31, 2022
| @@ -65,7 +65,7 @@ func (o *DeployOptions) Complete(cmdline cmdline.Cmdline, args []string) (err er | |||
| return err | |||
| } | |||
| if isEmptyDir { | |||
| return errors.New("this command cannot run in an empty directory, you need to run it in a directory containing source code") | |||
| return errors.New("this command cannot run in an empty directory, run the command in a directory containing source code or initialize using 'odo init'") | |||
There was a problem hiding this comment.
Can't we define a sentinel error for this one in the component pkg? Something like the following -
var EmptyDirError := errors.New("this command cannot run in an empty directory, run the command in a directory containing source code or initialize using 'odo init'")There was a problem hiding this comment.
Hey @valaparthvi I want to try and keep the error logging consistent across odo so I prefer not creating a sentinal error despite it being copy and pasted in two places...
Preferably because using those types of errors are unconventional and I want to make this PR more of a UI/UX change rather than adding to pkg/component instead of pkg/cli
There was a problem hiding this comment.
In that case,
/lgtm
/approve
openshift-ci
bot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: valaparthvi 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 |
openshift-ci
bot
added
the
approved
cdrage
added a commit
to cdrage/odo
that referenced
this pull request
Aug 31, 2022
<!-- Thank you for opening a PR! Here are some things you need to know before submitting: 1. Please read our developer guideline: https://github.com/redhat-developer/odo/wiki/Dev:-odo-Dev-Guidelines 2. Label this PR accordingly with the '/kind' line 3. Ensure you have written and ran the appropriate tests: https://github.com/redhat-developer/odo/wiki/Dev:-Writing-and-running-tests 4. Read how we approve and LGTM each PR: https://github.com/redhat-developer/odo/wiki/Pull-Requests:-Review-guideline Documentation: If you are pushing a change to documentation, please read: https://github.com/redhat-developer/odo/wiki/Documentation:-Contributing --> **What type of PR is this:** <!-- Add one of the following kinds: /kind bug /kind feature /kind cleanup /kind tests /kind documentation Feel free to use other [labels](https://github.com/redhat-developer/odo/labels) as needed. However one of the above labels must be present or the PR will not be reviewed. This instruction is for reviewers as well. --> **What does this PR do / why we need it:** Updates the error output for running `odo dev` or `odo deploy` in an empty directory. Telling the user to run the same command in a non-empty dir, OR use `odo init`. **Which issue(s) this PR fixes:** <!-- Specifying the issue will automatically close it when this PR is merged --> N/A **PR acceptance criteria:** - [X] Unit test - [X] Integration test - [X] Documentation **How to test changes / Special notes to the reviewer:** Signed-off-by: Charlie Drage <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this:
What does this PR do / why we need it:
Updates the error output for running
odo devorodo deployin anempty directory. Telling the user to run the same command in a non-empty
dir, OR use
odo init.Which issue(s) this PR fixes:
N/A
PR acceptance criteria:
Unit test
Integration test
Documentation
How to test changes / Special notes to the reviewer:
Signed-off-by: Charlie Drage [email protected]