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

Reformatted Deprecation and Error Messages for Bundler v1 Support #10450

Merged
merged 1 commit into from
Aug 16, 2024

Conversation

kbukum1
Copy link
Contributor

@kbukum1 kbukum1 commented Aug 15, 2024

What are you trying to accomplish?

This PR reformats the deprecation and error messages related to Bundler v1 support. The goal is to make the messaging clearer and more grammatically accurate for users when they encounter notices about upgrading or unsupported versions.

What issues does this affect or fix?

This change improves the readability and clarity of the deprecation warnings and error messages for Bundler v1, ensuring that users have a better understanding of the steps they need to take.

Anything you want to highlight for special attention from reviewers?

The focus was on improving the grammar and structure of the messages. Please review the changes to ensure that the messaging is clear and that no important information was lost in the reformatting.

How will you know you've accomplished your goal?

  • The deprecation and error messages are clearer and more grammatically correct.
  • Users encountering these messages should have a better understanding of the required actions.

Checklist

  • I have run the complete test suite to ensure all tests and linters pass.
  • I have thoroughly tested my code changes to ensure they work as expected, including adding additional tests for new functionality.
  • I have written clear and descriptive commit messages.
  • I have provided a detailed description of the changes in the pull request, including the problem it addresses, how it fixes the problem, and any relevant details about the implementation.
  • I have ensured that the code is well-documented and easy to understand.

@kbukum1 kbukum1 marked this pull request as ready for review August 15, 2024 22:01
@kbukum1 kbukum1 requested a review from a team as a code owner August 15, 2024 22:01
@kbukum1
Copy link
Contributor Author

kbukum1 commented Aug 15, 2024

Here is how an example of how PR shows:

Warning

Dependabot will stop supporting bundler v1!

Please upgrade to version v2.

Bumps concurrent-ruby from 1.2.3 to 1.3.4.

Release notes

Sourced from concurrent-ruby's releases.

v1.3.4

What's Changed

New Contributors

Full Changelog: ruby-concurrency/concurrent-ruby@v1.3.3...v1.3.4

v1.3.3

What's Changed

Full Changelog: ruby-concurrency/concurrent-ruby@v1.3.2...v1.3.3

v1.3.2

What's Changed

New Contributors

Full Changelog: ruby-concurrency/concurrent-ruby@v1.3.1...v1.3.2

v1.3.1

This release is essentially v1.3.0, but with a properly packaged gem. There was an issue publishing v1.3.0 and that gem needed to be yanked to avoid breaking downstream projects. The v1.3.0 changelog is reproduced below.

What's Changed

New Contributors

Full Changelog: ruby-concurrency/concurrent-ruby@v1.2.3...v1.3.1

v1.3.0

There was a packaging issue that resulted in a broken v1.3.0 gem having been pushed to RubyGems. The code corresponding to this tag is fine to use, but there is no corresponding v1.3.0 gem as we had to yank it. Please use v1.3.1 instead, which is nothing more than v1.3.0 packaged correctly.

What's Changed

... (truncated)

Changelog

Sourced from concurrent-ruby's changelog.

Release v1.3.4 (10 August 2024)

  • (#1060) Fix bug with return value of Concurrent.available_processor_count when cpu.cfs_quota_us is -1.
  • (#1058) Add Concurrent.cpu_shares that is cgroups aware.

Release v1.3.3 (9 June 2024)

  • (#1053) Improve the speed of Concurrent.physical_processor_count on Windows.

Release v1.3.2, edge v0.7.1 (7 June 2024)

concurrent-ruby:

  • (#1051) Remove dependency on win32ole.

concurrent-ruby-edge:

  • (#1052) Fix dependency on concurrent-ruby to allow the latest release.

Release v1.3.1 (29 May 2024)

  • Release 1.3.0 was broken when pushed to RubyGems. 1.3.1 is a packaging fix.

Release v1.3.0 (28 May 2024)

  • (#1042) Align Java Executor Service behavior for shuttingdown?, shutdown?
  • (#1038) Add Concurrent.available_processor_count that is cgroups aware.
Commits
  • 044020f Avoid requiring files of the gem in Rakefile to avoid redefined method warnings
  • 09bfcd0 Avoid require in Gemfile & Rakefile to avoid redefined constant warnings
  • f131214 Avoid require in *.gemspec files to avoid redefined constant warnings
  • 13badd0 Update docs-source/signpost.md
  • 8fefd59 1.3.4
  • e671fec Check early that $CONCURRENT_JRUBY_HOME is set
  • 98d0f16 Fix the return value of Concurrent.available_processor_count when `cpu.cfs_...
  • cbee215 Fix the doc of Concurrent.available_processor_count
  • 6f7c91a Add Concurrent.cpu_shares that is cgroups aware.
  • cadc8de Update comment for JRuby variant of processor_count to reality
  • Additional commits viewable in compare view

@kbukum1 kbukum1 merged commit 40b0760 into main Aug 16, 2024
122 checks passed
@kbukum1 kbukum1 deleted the kamil/update_bundler_v1_deprecation_text branch August 16, 2024 01:08
imajes pushed a commit to imajes/dependabot-core that referenced this pull request Sep 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants