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

feat: Add context aware V2 API #14

Merged

Conversation

LucasRoesler
Copy link
Contributor

This new v2 module requires context, so that cancellation can be propagated correctly to sub-commands. This enables cancelling sub-command (#10) and adding timeouts (solving #9) via context.WithTimeout

Some additional streamlining of the code to reduce the number of exec.Execute calls.

The new behavior is covered by additional tests and the package should have 98% coverage.

Closes #11
Resolves #9
Resolves #10

How Has This Been Tested?

Additional unit tests cover the new use cases.

How are existing users impacted? What migration steps/scripts do we need?

New users would need to change their import to use the new API.

Checklist:

I have:

  • updated the documentation and/or roadmap (if required)
  • read the CONTRIBUTION guide
  • signed-off my commits with git commit -s
  • added unit tests

Sorry, something went wrong.

This new v2 module requires context, so that cancellation can be
propogated correctly to sub-commands.

Some additional streamlining of the code to reduce the number of
`exec.Execute` calls.

The new behavior is covered by additional tests and the package should
have 98% coverage.

Signed-off-by: Lucas Roesler <roesler.lucas@gmail.com>
@derek derek bot added the new-contributor label Jul 3, 2023
Copy link
Owner

@alexellis alexellis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved

@alexellis alexellis merged commit e7b8802 into alexellis:master Jul 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants