rubygems-update 3.1.6 → 3.4.10

data/POLICIES.md

@@ -2,15 +2,8 @@
 
 Contributions to RubyGems are made via GitHub pull requests, which must be
 approved by a project committer other than the author. To approve a PR, a
-maintainer can leave a comment including the text "@bundlerbot r+", indicating
-that they have reviewed the PR and approve it. Bundlerbot will then
-automatically create a merge commit, test the merge, and land the PR if the
-merge commit passes the tests.
-
-This process guarantees that our release branches always have passing tests,
-and reduces siloing of information to a single contributor. For a full list of
-possible commands, see [the Bundlerbot
-documentation](https://bors.tech/documentation/).
+maintainer can use GitHubs PR review feature. After that, if the original author
+is happy to merge the PR, she can press the merge button.
 
 ## Long-Term Support
 
@@ -49,10 +42,21 @@ at version 2.7, so when RubyGems 2.8 is released, it will only support Ruby
 
 ## Release Process
 
-Releases of new versions should follow these steps, to ensure the process is
-smooth and no needed steps are missed.
+### Permissions
+
+You'll need the following environment variables set to release RubyGems &
+Bundler:
+
+* AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY: to be able to push RubyGems zip
+  files to s3 so that they appear at RubyGems [download page].
+
+* GITHUB_RELEASE_PAT: A [GitHub PAT] with repo permissions, in order to push
+  GitHub releases and to use the GitHub API for changelog generation.
 
-### Steps for security releases
+[download page]: https://rubygems.org/pages/download
+[GitHub PAT]: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token
+
+### Recommendations for security releases
 
 *   Obtain CVE numbers as needed from HackerOne or Red Hat.
 *   Agree on a release date with ruby-core, so patches can be backported to
@@ -61,16 +65,55 @@ smooth and no needed steps are missed.
     have to work on weekends.
 *   Continue with the regular release process below.
 
-
-### Steps for all releases
-
-*   Confirm milestone on GitHub is complete
-*   Update History.txt
-*   Update Manifest.txt
-*   Create and push git tag
-*   Create and push `rubygems-update` gem and tgz
-*   Publish blog post
-
+### Automatic changelog and backport generation
+
+PR labels and titles are used to automatically generate changelogs for patch and
+minor releases.
+
+When releasing, a changelog generation script goes through all PRs that have
+never made it into a release, and selects only the ones with specific labels as
+detailed in the `.changelog.yml` and `bundler/.changelog.yml` files. Those
+particular PRs get backported to the stable branch and included in the release
+changelog.
+
+If PRs don't have a proper label, they won't be backported to patch releases.
+
+If you want a PR to be backported to a patch level release, but don't want to
+include it in the changelog, you can use the special `rubygems: backport` and
+`bundler: backport` labels. For example, this is useful when backporting a PR
+generates conflicts that are solved by backporting another PR with no user
+visible changes. You can use these special labels to also backport the other PR
+and not get any conflicts.
+
+### Steps for patch releases
+
+*   Confirm all PRs that you want backported are properly tagged with `rubygems:
+    <type>` or `bundler: <type>` labels at GitHub.
+*   Run `rake prepare_release[<target_version>]`. This will create a PR to the
+    stable branch with the backports included in the release, and proper
+    changelogs and version bumps. It will also create a PR to merge release
+    changelogs into master.
+*   Once CI passes, merge the release PR, switch to the stable branch and pull
+    the PR just merged.
+*   Release `bundler` with `(cd bundler && bin/rake release)`.
+*   Release `rubygems` with `rake release`.
+
+### Steps for minor and major releases
+
+*   Confirm all PRs that you want listed in changelogs are properly tagged with
+    `rubygems: <type>` or `bundler: <type>` labels at GitHub.
+*   Run `rake prepare_release[<target_version>]`. This will create a new stable
+    branch off the master branch, and create a PR to it with the proper version
+    bumps and changelogs. It will also create a PR to merge release changelogs
+    into master.
+*   Replace the stable branch in the workflows with the new stable branch, and
+    push that change to the release PR.
+*   Replace version numbers with the next ".dev" version, and push that change
+    to the master PR.
+*   Once CI passes, merge the release PR, switch to  the stable branch and pull
+    the PR just merged.
+*   Release `bundler` with `(cd bundler && bin/rake release)`.
+*   Release `rubygems` with `rake release`.
 
 ## Committer Access
 
@@ -85,8 +128,8 @@ permissions compromised or exposed.
 
 ## Changing These Policies
 
-These policies were set in order to reduce the burden of maintenance and to
-keep committers current with existing development and policies. RubyGems work
-is primarily volunteer-driven which limits the ability to provide long-term
-support. By joining [Ruby Together](https://rubytogether.org) you can help
-extend support for older RubyGems versions.
+These policies were set in order to reduce the burden of maintenance and to keep
+committers current with existing development and policies. RubyGems work is
+primarily volunteer-driven which limits the ability to provide long-term
+support. By joining [Ruby Central](https://rubycentral.org/#/portal/signup) you
+can help extend support for older RubyGems versions.

data/README.md

@@ -33,21 +33,25 @@ For more information about how to use RubyGems, see our RubyGems basics guide at
 
 ## Installation
 
-RubyGems is likely already installed in your Ruby environment, you can check by running `gem --version` in your terminal emulator.
-In some cases your OS's package manager may install RubyGems as a separate package from Ruby. It's recommended to check
-with your OS's package manager before installing RubyGems manually.
+RubyGems is already installed in your Ruby environment, you can check the version you have installed by running `gem --version` in your terminal emulator.
+
+In some cases Ruby & RubyGems may be provided as OS packages. This is not a
+recommended way to use Ruby & RubyGems. It's better to use a Ruby Version
+Manager, such as [rbenv](https://github.com/rbenv/rbenv) or
+[chruby](https://github.com/postmodern/chruby). If you still want to use the
+version provided by your OS package manager, please also use your OS package
+manager to upgrade rubygems, and disregard any other installation instructions
+given below.
 
 If you would like to manually install RubyGems:
 
 * Download from https://rubygems.org/pages/download, unpack, and `cd` into RubyGems' src
-* OR clone this repository and `cd` into the repository (make sure to run `git submodule update --init`)
+* OR clone this repository and `cd` into the repository
 
 Install RubyGems by running:
 
     $ ruby setup.rb
 
-Note: You may need to run the install script with admin/root privileges.
-
 For more details and other options, see:
 
     $ ruby setup.rb --help
@@ -58,10 +62,24 @@ To upgrade to the latest RubyGems, run:
 
     $ gem update --system
 
-Note: You might need to run the command as an administrator or root user.
-
 See [UPGRADING](UPGRADING.md) for more details and alternative instructions.
 
+## Release policy
+
+RubyGems and Bundler are released in sync, although they do not share their
+major version number. It is planned that also their major version numbers will
+be sync'ed in the future.
+
+The release policy is somewhat similar to the release policy of Ruby itself:
+
+* Frequent patch releases (every 2-4 weeks) including bug fixes, minor
+  enhancements, small features, or even medium sized features declared as
+  experimental for battle testing.
+* Yearly minor releases including bigger features, and minor breaking changes
+  (affecting only edge cases and a very small set of users).
+* Occasional major releases (replacing yearly minors) including major breaking
+  changes.
+
 ## Documentation
 
 RubyGems uses [rdoc](https://github.com/rdoc/rdoc) for documentation. A compiled set of the docs
@@ -77,23 +95,20 @@ creating a new gem, security practices and other resources at https://guides.rub
 Got a bug and you're not sure?  You're sure you have a bug, but don't know
 what to do next?  In any case, let us know about it!  The best place
 for letting the RubyGems team know about bugs or problems you're having is
-[on the RubyGems issues page at GitHub](http://github.com/rubygems/rubygems/issues).
+[on the RubyGems issues page at GitHub](https://github.com/rubygems/rubygems/issues).
 
 ### Bundler Compatibility
 
-See http://bundler.io/compatibility for known issues.
+See https://bundler.io/compatibility for known issues.
 
 ### Supporting
 
-<a href="https://rubytogether.org/"><img src="https://rubytogether.org/images/rubies.svg" width=200></a><br/>
-<a href="https://rubytogether.org/">Ruby Together</a> pays some RubyGems maintainers for their ongoing work. As a grassroots initiative committed to supporting the critical Ruby infrastructure you rely on, Ruby Together is funded entirely by the Ruby community. Contribute today <a href="https://rubytogether.org/developers">as an individual</a> or even better, <a href="https://rubytogether.org/companies">as a company</a>, and ensure that RubyGems, Bundler, and other shared tooling is around for years to come.
+RubyGems is managed by [Ruby Central](https://rubycentral.org), a non-profit organization that supports the Ruby community through projects like this one, as well as [RubyConf](https://rubyconf.org), [RailsConf](https://railsconf.org), and [RubyGems.org](https://rubygems.org). You can support Ruby Central by attending or [sponsoring](sponsors@rubycentral.org) a conference, or by [joining as a supporting member](https://rubycentral.org/#/portal/signup).
 
 ### Contributing
 
 If you'd like to contribute to RubyGems, that's awesome, and we <3 you. Check out our [guide to contributing](CONTRIBUTING.md) for more information.
 
-While some RubyGems contributors are compensated by Ruby Together, the project maintainers make decisions independent of Ruby Together. As a project, we welcome contributions regardless of the author’s affiliation with Ruby Together.
-
 ### Code of Conduct
 
 Everyone interacting in the RubyGems project’s codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [contributor code of conduct](https://github.com/rubygems/rubygems/blob/master/CODE_OF_CONDUCT.md).

data/UPGRADING.md

@@ -1,91 +1,15 @@
 # How to upgrade/downgrade Rubygems:
 
-## For RubyGems 1.5.0 and 1.5.1:
-
-RubyGems 1.5.0 and 1.5.1 shipped with a broken `gem update --system`. You will
-need to use the Manual Upgrade Recipe below.
-
-## On Ruby 1.9.x:
-
-### From stock ruby shipping with 1.9:
-
-Use the Normal Upgrade Method below. (finally!)
-
-## On Ruby 1.8.x:
-
-### From rubygems 1.3.x:
-
-Use the Normal Upgrade Recipe below.
-
-### From rubygems 1-1.x through 1.2.x:
-
-RubyGems 1.1 and 1.2 have problems upgrading when there is no rubygems-update
-installed. You will need to use the following instructions if you see "Nothing
-to update".
-
-Use the Manual Upgrade Recipe below.
-
-### From rubygems < 1.1.x:
-
-Use the Normal Upgrade Recipe below.
-
 ## Downgrade Recipe
 
-### Normal Downgrade
-
-#### With rubygems 1.5.2 and higher:
-
-    $ gem update --system 1.3.7
-
-#### With rubygems 1.5.1 and lower:
+    $ gem update --system 3.1.4
 
-Use sudo/su as appropriate:
-
-    $ gem install rubygems-update -v 1.3.7
-    $ update_rubygems _1.3.7_
-
-Replace 1.3.7 with whatever version you want to downgrade to. This recipe can
-also be used to upgrade to a specific version instead of the latest.
-
-Do make sure that you don't have any other versions of rubygems-update
-installed when you run the second command.
-
-### 1.9.2 Downgrade from Rubygems 1.4.x+ to stock 1.9 rubygems:
-
-Use sudo/su as appropriate:
-
-    $ ruby --disable-gems -S gem which rubygems
-    ~/.rvm/rubies/ruby-1.9.2-p136/lib/ruby/site_ruby/1.9.1/rubygems.rb
-    $ rm ~/.rvm/rubies/ruby-1.9.2-p136/lib/ruby/site_ruby/1.9.1/rubygems.rb
-    $ rm -rf ~/.rvm/rubies/ruby-1.9.2-p136/lib/ruby/site_ruby/1.9.1/rubygems
-    $ gem -v
-    1.3.7
-
-## Upgrade Recipes
-
-### Normal Upgrade
-
-Use sudo/su as appropriate:
+## Upgrade Recipe
 
     $ gem update --system
 
-### Manual Upgrade
-
-If you have an older version of RubyGems installed, then you can still do it
-in two steps:
-
-Use sudo/su as appropriate:
-
-    $ gem install rubygems-update
-    $ update_rubygems
-
-### Manual Install
-
-If you don't have any RubyGems install, there is still the pre-gem approach to
-getting software, doing it manually:
-
-Use sudo/su as appropriate:
+## Install from source
 
 *   Download from: https://rubygems.org/pages/download
-*   Unpack into a directory and cd there
-*   Install with: ruby setup.rb
+*   Unpack into a directory and `cd` there
+*   Install with: `ruby setup.rb`

data/bin/gem

@@ -5,14 +5,6 @@
 # See LICENSE.txt for permissions.
 #++
 
-require 'rubygems'
-require 'rubygems/gem_runner'
-require 'rubygems/exceptions'
+require "rubygems/gem_runner"
 
-args = ARGV.clone
-
-begin
-  Gem::GemRunner.new.run args
-rescue Gem::SystemExitException => e
-  exit e.exit_code
-end
+Gem::GemRunner.new.run ARGV.clone

data/bin/update_rubygems

@@ -5,9 +5,9 @@
 # See LICENSE.txt for permissions.
 #++
 
-require 'rubygems'
+require "rubygems"
 
-if ARGV.include? '-h' or ARGV.include? '--help'
+if ARGV.include?("-h") || ARGV.include?("--help")
   $stderr.puts "rubygems_update [options]"
   $stderr.puts
   $stderr.puts "This will install the latest version of RubyGems."
@@ -17,10 +17,10 @@ if ARGV.include? '-h' or ARGV.include? '--help'
 end
 
 unless ARGV.grep(/--version=([\d\.]*)/).empty?
-  exec Gem.ruby, '-S', $PROGRAM_NAME, "_#{$1}_"
+  exec Gem.ruby, "-S", $PROGRAM_NAME, "_#{$1}_"
 end
 
-update_dir = $LOAD_PATH.find { |dir| dir =~ /rubygems-update/ }
+update_dir = $LOAD_PATH.find {|dir| dir.include?("rubygems-update") }
 
 if update_dir.nil?
   puts "Error: Cannot find RubyGems update path!"
@@ -32,5 +32,5 @@ else
   update_dir = File.dirname(update_dir)
   Dir.chdir update_dir
   ENV["GEM_PREV_VER"] = Gem::VERSION
-  abort unless system(Gem.ruby, 'setup.rb', *ARGV)
+  abort unless system(Gem.ruby, "setup.rb", *ARGV)
 end