Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.
Sign upMake `code` on `ExecuteGoalResult` optional #586
Conversation
cdupuis
requested a review
from
ddgenome
Nov 29, 2018
cdupuis
changed the title
Autofix: tslint
Make `code` on `ExecuteGoalResult` optional
Nov 29, 2018
ddgenome
reviewed
Nov 29, 2018
Should clarify in TypeDoc about how to return success and failure. |
lib/api/goal/ExecuteGoalResult.ts
Outdated
if (!result.code) { | ||
return true; | ||
} | ||
return result.code === 0; |
This comment has been minimized.
This comment has been minimized.
lib/api/goal/ExecuteGoalResult.ts
Outdated
@@ -70,10 +70,32 @@ export interface ExecuteGoalResult extends GoalDetails { | |||
* 0 is success; non-zero exit codes will mark the goal as failed, |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
ddgenome
Nov 29, 2018
Member
For the ExecuteGoalResult
TypeDoc, something like:
/**
* Result from a successful goal execution allowing you to provide an optional success message.
* If the goal is unsuccessful, throw a description `Error`.
*/
cdupuis
force-pushed the
optional-code
branch
from
f94a602
to
42cd989
Nov 29, 2018
cdupuis
removed
the
auto-merge-method:squash
label
Nov 29, 2018
This comment has been minimized.
This comment has been minimized.
Pull request auto merged by Atomist.
[atomist:generated] [auto-merge:on-approve] |
atomist-bot
merged commit e92ee2c
into
master
Nov 29, 2018
atomist-bot
deleted the
optional-code
branch
Nov 29, 2018
added a commit
that referenced
this pull request
Nov 29, 2018
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.
cdupuis commentedNov 29, 2018
•
edited
Omitting
code
meanssuccess
as doescode: 0
.