Removed the direct inclusion of Pry and make it conditional based on the ENABLE_PRY environment variable #2265
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.
Before contributing, please read our contributing guidelines and code of conduct.
Overview
I update all the configuration files by removing Pry from the default setup and add a conditional configuration.
Here is how a Developers can enable or disable "Pry" in the process of Debugging:
Debugging with Pry
To Enable Pry for debugging, follow these steps:
ENABLE_PRY
environment variable by running the following command:export ENABLE_PRY=1
This command enables Pry for the current session.
Debugging without Pry
To Disable Pry for debugging, follow these steps:
Set the
ENABLE_PRY
environment variable by running the following command:unset ENABLE_PRY
Note: Pry is included only when the ENABLE_PRY environment variable is set. When it's not set, Pry will not be part of your project's default setup
Submitter Checklist:
Testing
The agent includes a suite of unit and functional tests which should be used to
verify your changes don't break existing functionality. These tests will run with
GitHub Actions when a pull request is made. More details on running the tests locally can be found
here for our unit tests,
and here for our functional tests.
For most contributions it is strongly recommended to add additional tests which
exercise your changes.
Reviewer Checklist