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

🥅 Throw exit status 1 when crashing gracefully #2020

Merged
merged 3 commits into from
May 22, 2024
Merged

Conversation

shnizzedy
Copy link
Member

@shnizzedy shnizzedy commented Nov 10, 2023

I think we should sit on this one until after 1.8.7 is out so we can put it through the ringer before we release it.

Fixes

Fixes cmi-cnl.slack#user_support@p1698686578542339 by @clane9

Description

Sets a non-zero exit code when C-PAC catches an exception.

Technical details

Before this PR, the docstring for run_workflow said

Returns
-------
workflow : nipype workflow
the prepared nipype workflow object containing the parameters
specified in the config
, but it didn't really; it implicitly returned None. Here we update that function to return an exit code, 0 for success and 1 otherwise (with a note
# If we want to throw other exit codes, we can catch various
# specific exceptions to do so
)

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the develop branch of the repository.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added tests for the changes I made (if applicable).
  • I updated the changelog.
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@shnizzedy shnizzedy marked this pull request as ready for review May 9, 2024 21:34
@shnizzedy shnizzedy requested a review from a team May 9, 2024 21:34
@shnizzedy shnizzedy added improvement engine Internal implementation changes that may not be visible to users. enhancement labels May 9, 2024
@shnizzedy shnizzedy added this to the 1.8.8 release milestone May 9, 2024
@shnizzedy shnizzedy merged commit bf177b5 into develop May 22, 2024
43 checks passed
@shnizzedy shnizzedy deleted the exitcode1 branch May 22, 2024 23:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
engine Internal implementation changes that may not be visible to users. enhancement improvement
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants