Merge branch 'master' into jruby-10-compat

comandeo-mongo · comandeo-mongo · commit b9ed42a4666e · 2025-10-10T13:25:14.000+02:00
diff --git a/.github/workflows/bson-ruby.yml b/.github/workflows/bson-ruby.yml
@@ -1,14 +1,15 @@
 name: CI
 
-on: [push, pull_request]
+on: [push, pull_request, workflow_dispatch]
 
 jobs:
   rubocop:
     runs-on: ubuntu-latest
     env:
       CI: true
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
+
       - name: Set up Ruby 3.4
         uses: ruby/setup-ruby@v1
         with:
@@ -34,27 +35,24 @@ jobs:
       fail-fast: false
       matrix:
         os: [ ubuntu, macos, windows ]
-        ruby: [ 2.7, 3.0, 3.1, 3.2, 3.3, 3.4, head ]
+        ruby: [ 2.7, '3.0', 3.1, 3.2, 3.3, 3.4, head ]
         include:
-          - { os: windows , ruby: mingw }
+          - { os: windows , ruby: ucrt }
         exclude:
           - { os: windows , ruby: head }
-          - { os: windows , ruby: 3.1 }
 
     steps:
       - name: repo checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           submodules: recursive
 
-      - name: load ruby, ragel
+      - name: load ruby
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          bundler: 2
-
-      - name: bundle install
-        run:  bundle install --jobs 4 --retry 3
+          rubygems: latest
+          bundler-cache: true
 
       - name: compile
         run:  bundle exec rake compile
diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
@@ -36,6 +36,8 @@ jobs:
     steps:
     - name: Checkout repository
       uses: actions/checkout@v4
+      with:
+        submodules: true
 
     - name: Setup Ruby
       if: matrix.build-mode == 'manual'
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -2,32 +2,24 @@ name: "BSON Release"
 run-name: "BSON Release for ${{ github.ref }}"
 
 on:
+  # for auto-deploy when merging a release-candidate PR
+  push:
+    branches:
+      - 'master'
+      - '*-stable'
+
+  # for manual release
   workflow_dispatch:
     inputs:
-      dry_run:
-        description: Whether this is a dry run or not
+      pr:
+        description: "The number of the merged release candidate PR"
         required: true
-        default: true
-        type: boolean
 
 env:
   SILK_ASSET_GROUP: bson-ruby
-  RELEASE_MESSAGE_TEMPLATE: |
-    Version {0} of [BSON for Ruby](https://rubygems.org/gems/bson) is now available.
-
-    **Release Highlights**
-
-    TODO: one or more paragraphs describing important changes in this release
-
-    **Documentation**
-
-    Documentation is available at [MongoDB.com](https://www.mongodb.com/docs/ruby-driver/current/tutorials/bson/).
-
-    **Installation**
-
-    You may install this version via RubyGems, with:
-
-    gem install --version {0} bson
+  GEM_NAME: bson
+  PRODUCT_NAME: BSON for Ruby
+  PRODUCT_ID: mongodb-ruby-driver
 
 permissions:
   # required for all workflows
@@ -38,133 +30,63 @@ permissions:
 
   # only required for workflows in private repositories
   actions: read
+  pull-requests: read
   contents: write
 
   # required by the mongodb-labs/drivers-github-tools/setup@v2 step
   # also required by `rubygems/release-gem`
   id-token: write
 
 jobs:
+  check:
+    name: "Check Release"
+    runs-on: ubuntu-latest
+    outputs:
+      message: ${{ steps.check.outputs.message }}
+      ref: ${{ steps.check.outputs.ref }}
+    steps:
+      - name: "Run the check action"
+        id: check
+        uses: jamis/drivers-github-tools/ruby/pr-check@ruby-3643-update-release-process
+
   build:
     name: "Build Gems"
+    needs: check
+    environment: release
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '3.2', jruby ]
+        ruby: [ 'ruby-3.2', 'jruby-9.4' ]
     steps:
-      - name: Check out the repository
-        uses: actions/checkout@v4
-
-      - name: Setup Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-
-      - name: Set output gem file name
-        shell: bash
-        run: |
-          echo "GEM_FILE_NAME=$(bundle exec rake gem_file_name)" >> "$GITHUB_ENV"
-
-      - name: Build the gem
-        shell: bash
-        run: bundle exec rake build
-
-      - name: Save the generated gem file for later
-        uses: actions/upload-artifact@v4
+      - name: "Run the build action"
+        uses: jamis/drivers-github-tools/ruby/build@ruby-3643-update-release-process
         with:
-          name: ${{ env.GEM_FILE_NAME }}
-          path: ${{ env.GEM_FILE_NAME }}
-          retention-days: 1
-          overwrite: true
+          app_id: ${{ vars.APP_ID }}
+          app_private_key: ${{ secrets.APP_PRIVATE_KEY }}
+          artifact: ${{ matrix.ruby }}
+          gem_name: ${{ env.GEM_NAME }}
+          ruby_version: ${{ matrix.ruby }}
+          ref: ${{ needs.check.outputs.ref }}
 
   publish:
     name: Publish Gems
-    needs: build
+    needs: [ check, build ]
     environment: release
     runs-on: ubuntu-latest
     steps:
-      - name: Check out the repository
-        uses: mongodb-labs/drivers-github-tools/secure-checkout@v2
+      - name: "Run the publish action"
+        uses: jamis/drivers-github-tools/ruby/publish@ruby-3643-update-release-process
         with:
           app_id: ${{ vars.APP_ID }}
-          private_key: ${{ secrets.APP_PRIVATE_KEY }}
-
-      - name: Setup Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: '3.2'
-          bundler-cache: true
-
-      - name: Get the release version
-        shell: bash
-        run: echo "RELEASE_VERSION=$(bundle exec rake version)" >> "$GITHUB_ENV"
-
-      - name: Setup GitHub tooling for DBX Drivers
-        uses: mongodb-labs/drivers-github-tools/setup@v2
-        with:
+          app_private_key: ${{ secrets.APP_PRIVATE_KEY }}
           aws_role_arn: ${{ secrets.AWS_ROLE_ARN }}
           aws_region_name: ${{ vars.AWS_REGION_NAME }}
           aws_secret_id: ${{ secrets.AWS_SECRET_ID }}
-
-      - name: Fetch the gem artifacts
-        uses: actions/download-artifact@v4
-        with:
-          merge-multiple: true
-
-      - name: Sign the gems
-        uses: mongodb-labs/drivers-github-tools/gpg-sign@v2
-        with:
-          filenames: '*.gem'
-
-      - name: Generate SSDLC Reports
-        uses: mongodb-labs/drivers-github-tools/full-report@v2
-        with:
-          product_name: BSON for Ruby
-          release_version: ${{ env.RELEASE_VERSION }}
-          dist_filenames: '*.gem'
-          silk_asset_group: bson-ruby
-
-      - name: Create the tag
-        uses: mongodb-labs/drivers-github-tools/tag-version@v2
-        with:
-          version: ${{ env.RELEASE_VERSION }}
-          tag_template: "v${VERSION}"
-          tag_message_template: "Release tag for v${VERSION}"
-
-      - name: Create a new release
-        shell: bash
-        run: gh release create v${{ env.RELEASE_VERSION }} --title ${{ env.RELEASE_VERSION }} --generate-notes --draft
-
-      - name: Capture the changelog
-        shell: bash
-        run: gh release view v${{ env.RELEASE_VERSION }} --json body --template '{{ .body }}' >> changelog
-
-      - name: Prepare release message
-        shell: bash
-        run: |
-          echo "${{ format(env.RELEASE_MESSAGE_TEMPLATE, env.RELEASE_VERSION) }}" > release-message
-          cat changelog >> release-message
-
-      - name: Update release information
-        shell: bash
-        run: |
-          echo "RELEASE_URL=$(gh release edit v${{ env.RELEASE_VERSION }} --notes-file release-message)" >> "$GITHUB_ENV"
-
-      - name: Upload release artifacts
-        shell: bash
-        run: gh release upload v${{ env.RELEASE_VERSION }} *.gem ${{ env.RELEASE_ASSETS }}/*.sig
-
-      - name: Upload S3 assets
-        uses: mongodb-labs/drivers-github-tools/upload-s3-assets@v2
-        with:
-          version: ${{ env.RELEASE_VERSION }}
-          product_name: 'bson-ruby'
-          dry_run: ${{ inputs.dry_run }}
-
-      - name: Publish the gems
-        uses: rubygems/release-gem@v1
-        if: inputs.dry_run == false
-        with:
-          await-release: false
+          dry_run: false
+          gem_name: ${{ env.GEM_NAME }}
+          product_name: ${{ env.PRODUCT_NAME }}
+          product_id: ${{ env.PRODUCT_ID }}
+          release_message: ${{ needs.check.outputs.message }}
+          silk_asset_group: ${{ env.SILK_ASSET_GROUP }}
+          ref: ${{ needs.check.outputs.ref }}
diff --git a/Rakefile b/Rakefile
@@ -25,6 +25,10 @@ require "rake/extensiontask"
 require "rspec/core/rake_task"
 require 'fileutils'
 
+if File.exist?('./spec/shared/lib/tasks/candidate.rake')
+  load './spec/shared/lib/tasks/candidate.rake'
+end
+
 def jruby?
   defined?(JRUBY_VERSION)
 end
@@ -51,8 +55,10 @@ RSpec::Core::RakeTask.new(:rspec)
 
 desc 'Build the bson gem'
 task :build => [ :clean_all, *(jruby? ? :compile : nil) ] do
-  output = "--output=#{ENV['GEM_FILE_NAME']}" if ENV['GEM_FILE_NAME']
-  system "gem build #{output} bson.gemspec"
+  command = [ 'gem', 'build' ]
+  command << "--output=#{ENV['GEM_FILE_NAME']}" if ENV['GEM_FILE_NAME']
+  command << ENV['GEMSPEC'] || 'bson.gemspec'
+  system(*command)
 end
 
 # `rake version` is used by the deployment system so get the release version
@@ -64,22 +70,10 @@ task :version do
   puts BSON::VERSION
 end
 
-# `rake gem_file_name` is used by the deployment system so get the name of
-# the gem file to be generated. It must do nothing more than just print the
-# name of the gem file to generate.
-desc 'Print the name of the gem file to generate.'
-task :gem_file_name do
-  require 'bson/version'
-  base = "bson-#{BSON::VERSION}"
-  base << '-java' if jruby?
-  puts "#{base}.gem"
-end
-
 task :clean_all => :clean do
-  FileUtils.rm_f(File.join(File.dirname(__FILE__), 'lib', "bson_native.bundle"))
-  FileUtils.rm_f(File.join(File.dirname(__FILE__), 'lib', "bson_native.so"))
-  FileUtils.rm_f(File.join(File.dirname(__FILE__), 'lib', "bson_native.o"))
-  FileUtils.rm_f(File.join(File.dirname(__FILE__), 'lib', "bson-ruby.jar"))
+  %w[ bson-ruby.jar bson_native.bundle bson_native.so bson_native.o ].each do |file|
+    FileUtils.rm_f(File.join(File.dirname(__FILE__), 'lib', file))
+  end
 end
 
 task :spec => :compile do
@@ -91,15 +85,6 @@ end
 # been built (and signed via GPG), so we just need `rake release` to
 # push the gem to rubygems.
 task :release do
-  require 'bson/version'
-
-  # confirm: there ought to be two gems, one for MRI, and one for Java. These
-  # will have been previously generated by the 'BSON Release' GitHub action.
-  gems = Dir['*.gem']
-  if gems.length != 2
-    abort "Expected two gem files to be ready to release; got #{gems.length}"
-  end
-
   if ENV['GITHUB_ACTION'].nil?
     abort <<~WARNING
       `rake release` must be invoked from the `BSON Release` GitHub action,
@@ -114,6 +99,13 @@ task :release do
     WARNING
   end
 
+  # confirm: there ought to be two gems, one for MRI, and one for Java. These
+  # will have been previously generated by the 'build' job.
+  gems = Dir['*.gem']
+  if gems.length != 2
+    abort "Expected two gem files to be ready to release; got #{gems.inspect}"
+  end
+
   gems.each do |gem|
     system 'gem', 'push', gem
   end
diff --git a/ext/bson/extconf.rb b/ext/bson/extconf.rb
@@ -3,6 +3,6 @@
 
 require 'mkmf'
 
-$CFLAGS << ' -Wall -g -std=c99'
+append_cflags(["-Wall", "-g", "-std=c99"])
 
 create_makefile('bson_native')
diff --git a/lib/bson/version.rb b/lib/bson/version.rb
@@ -1,20 +1,9 @@
 # frozen_string_literal: true
-# rubocop:todo all
-
-# Copyright (C) 2009-2020 MongoDB Inc.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#   http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
 
 module BSON
-  VERSION = "5.0.2"
+  # The current version of the library.
+  #
+  # NOTE: this file is automatically updated via `rake candidate:create`.
+  # Manual changes to this file may be overwritten by that rake task.
+  VERSION = '5.1.1'
 end
diff --git a/product.yml b/product.yml
@@ -0,0 +1,9 @@
+---
+name: BSON for Ruby
+description: a fully featured [BSON specification](https://bsonspec.org/) implementation
+  in Ruby
+package: bson
+jira: https://jira.mongodb.org/projects/RUBY
+version:
+  number: 5.1.1
+  file: lib/bson/version.rb
diff --git a/spec/shared b/spec/shared
