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

Removed the direct inclusion of Pry and make it conditional based on the ENABLE_PRY environment variable #2265

Merged
merged 2 commits into from Oct 23, 2023

Conversation

AlajeBash
Copy link
Contributor

@AlajeBash AlajeBash commented Oct 17, 2023

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:

  1. Open a terminal in your project directory.
  2. Set the 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

  • Perform code review
  • Add performance label
  • Perform appropriate level of performance testing
  • Confirm all checks passed
  • Add version label prior to acceptance

@CLAassistant
Copy link

CLAassistant commented Oct 17, 2023

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added the community To tag external issues and PRs submitted by the community label Oct 17, 2023
@kaylareopelle kaylareopelle linked an issue Oct 17, 2023 that may be closed by this pull request
@kaylareopelle
Copy link
Contributor

kaylareopelle commented Oct 17, 2023

Hi @AlajeBash! Thanks for your submission!

Remember to sign the CLA so we'll be able to accept it! 😄

It looks like our Rubocop linter found a few issues:

Offenses:

test/environments/norails/Gemfile:20:3: 
  C: [Correctable] Layout/BlockAlignment: 
    end at 20, 2 is not aligned with group :development do at 15, 0.
  end
  ^^^
test/multiverse/suites/active_record_pg/active_record_test.rb:5[9](https://github.com/newrelic/newrelic-ruby-agent/actions/runs/6541169160/job/17792085637?pr=2265#step:6:10)7:7: 

  W: Lint/Debugger: Remove debugger entry point binding.pry.
      binding.pry
      ^^^^^^^^^^^

Once those are fixed, we'll be able to proceed with the review.

@AlajeBash
Copy link
Contributor Author

@kaylareopelle thank you for your and feedback, i will fix the offenses and sign the CLA.

@AlajeBash
Copy link
Contributor Author

@kaylareopelle i'm waiting for your review. Thanks

@kaylareopelle kaylareopelle merged commit cd6d3c3 into newrelic:dev Oct 23, 2023
5 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community To tag external issues and PRs submitted by the community
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Remove 'pry' as a dev dependency
3 participants