-
Notifications
You must be signed in to change notification settings - Fork 6
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
SM-1227: Improved error messages on failures #119
SM-1227: Improved error messages on failures #119
Conversation
No New Or Fixed Issues Found |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice addition with the unit tests!
The scope of these changes and the scope of SM-1227 don't seem to match up.
It looks like this:
- Alters the
action.yml
and default values passed - Changes multiple error message responses
- Adds the ability to have the SDK code execute in debug mode
With this, we will need to update the ticket and clarify in the QA notes what all has changed, so the testing covers the new changes.
When increasing the scope of the original ticket, I would advise caution and thinking about if it makes sense to be a separate effort.
@@ -14,6 +14,7 @@ inputs: | |||
base_url: | |||
description: "(Optional) For self-hosted bitwarden instances provide your https://your.domain.com" | |||
required: false | |||
default: "" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
โAdded default value to base_url, since the docs specifies that all required: false inputs needs a default value.โ
What documentation are you referring to?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You are right, it's not required but there is a note: https://github.com/actions/toolkit/tree/main/packages/core#inputsoutputs
If required set to be false, the input should have a default value in action.yml.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
๐๏ธ Tracking
https://bitwarden.atlassian.net/browse/SM-1227
๐ Objective
Improve error messages on failures.
Changes:
action.yml
: Added default value tobase_url
, since the docs specifies that allrequired: false
inputs needs a default value.src/main.ts
:access_token
input is required - consistency withaction.yml
BitwardenClient.loginWithAccessToken
response into the error handling.src/parser.ts
:โฐ Reminders before review
team
๐ฆฎ Reviewer guidelines
:+1:
) or similar for great changes:memo:
) or โน๏ธ (:information_source:
) for notes or general info:question:
) for questions:thinking:
) or ๐ญ (:thought_balloon:
) for more open inquiry that's not quite a confirmedissue and could potentially benefit from discussion
:art:
) for suggestions / improvements:x:
) or:warning:
) for more significant problems or concerns needing attention:seedling:
) or โป๏ธ (:recycle:
) for future improvements or indications of technical debt:pick:
) for minor or nitpick changes