Merge pull request #3926 from DataDog/tonycthsu/automate-update-gemfiles

Lock dependencies workflow

.github/dependency_filters.yml

@@ -0,0 +1,9 @@
+dependencies:
+  - Gemfile
+  - Appraisals
+  - datadog.gemspec
+  - tasks/appraisal.rake
+  - .github/workflows/lock-dependency.yml
+  - lib/datadog/version.rb
+  - appraisal/**
+  - gemfiles/**

.github/workflows/lock-dependency.yml

@@ -0,0 +1,128 @@
+name: Lock Dependency
+
+# TODO: Make this job mandatory
+# TODO: Make this on workflow_dispatch
+
+on:
+  # Limitation about `paths` types:
+  # > https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#git-diff-comparisons
+  push:
+    branches-ignore:
+      - master
+      - release
+      - '*-stable'
+  pull_request:
+    # Run this job when a PR is opened, covering the scenario where branch is ready and pushed before PR is opened.
+    types:
+      - opened
+
+
+# TODO: Improve concurrency between push event and pull_request event
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  pr:
+    name: Pull Request attached
+    runs-on: ubuntu-latest
+    outputs:
+      pr_found: ${{ steps.pr.outputs.pr_found }}
+      pr_base_ref: ${{ steps.pr.outputs.pr.base.ref }}
+    steps:
+      # Limitation with pull_request trigger: https://github.com/8BitJonny/gh-get-current-pr/tree/3.0.0/?tab=readme-ov-file#limitations
+      - uses: 8BitJonny/gh-get-current-pr@3.0.0
+        id: pr
+        with:
+          filterOutClosed: true # Don't trigger on commits with closed PRs, including merges into `master`.
+
+  dependency:
+    name: Depenedency changes
+    needs: pr
+    if: ${{ needs.pr.outputs.pr_found == 'true' }}
+    runs-on: ubuntu-latest
+    outputs:
+      changes: ${{ steps.changes.outputs.dependencies }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dorny/paths-filter@v3
+        id: changes
+        with:
+          # This is the best effort to get the diff comparison.
+          # The result remains time-sensitive since the `base` is constantly changing and
+          # the PR cannot be guaranteed to be up-to-date.
+          #
+          # Unless enable `Require branches to be up to date before merging` in the repository rule settings
+          base: ${{ needs.pr.outputs.pr_base_ref }}
+          filters: .github/dependency_filters.yml
+
+  lock:
+    runs-on: ubuntu-latest
+    needs: dependency
+    if: ${{ needs.dependency.outputs.changes == 'true' }}
+    strategy:
+      fail-fast: false
+      matrix:
+        engine:
+          # ADD NEW RUBIES HERE
+          - name: ruby
+            version: '3.4'
+          - name: ruby
+            version: '3.3'
+          - name: ruby
+            version: '3.2'
+          - name: ruby
+            version: '3.1'
+          - name: ruby
+            version: '3.0'
+          - name: ruby
+            version: '2.7'
+          - name: ruby
+            version: '2.6'
+          - name: ruby
+            version: '2.5'
+          - name: jruby
+            version: '9.4'
+          - name: jruby
+            version: '9.3'
+          - name: jruby
+            version: '9.2'
+    container:
+      image: ghcr.io/datadog/images-rb/engines/${{ matrix.engine.name }}:${{ matrix.engine.version }}
+      env:
+        BUNDLE_WITHOUT: check
+    steps:
+      - uses: actions/checkout@v4
+      - run: |
+          ruby -v
+          gem -v
+          bundler -v
+      - run: bundle install
+
+      # TODO: Migrate away from `appraisal`
+      - run: bundle exec appraisal generate
+      - run: bundle exec rake dependency:lock
+      - uses: actions/upload-artifact@v4
+        with:
+          name: lock-dependency-${{ github.run_id }}-${{ matrix.engine.name }}-${{ matrix.engine.version }}
+          path: gemfiles/${{ matrix.engine.name }}_${{ matrix.engine.version }}*
+
+  # TODO: Change token to trigger workflow automation
+  # > New commit by GITHUB_TOKEN does not trigger workflow automation to prevent infinite loop
+  commit:
+    name: Commit changes
+    needs: lock
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/download-artifact@v4
+        with:
+          path: gemfiles
+          pattern: lock-dependency-${{ github.run_id }}-*
+          merge-multiple: true
+      - uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          file_pattern: 'gemfiles/*'
+          commit_message: "[🤖] Lock Dependency: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"

Appraisals

@@ -52,7 +52,7 @@ def build_coverage_matrix(integration, range, gem: nil, min: nil, meta: {})
 
   if min
     appraise "#{integration}-min" do
-      gem gem, "= #{n}"
+      gem gem, "= #{min}"
       meta.each { |k, v| gem k, v }
     end
   end

Matrixfile

@@ -176,6 +176,8 @@
     'stripe-9'      => '✅ 2.5 / ✅ 2.6 / ✅ 2.7 / ✅ 3.0 / ✅ 3.1 / ✅ 3.2 / ✅ 3.3 / ✅ 3.4 / ✅ jruby',
     'stripe-8'      => '✅ 2.5 / ✅ 2.6 / ✅ 2.7 / ✅ 3.0 / ✅ 3.1 / ✅ 3.2 / ✅ 3.3 / ✅ 3.4 / ✅ jruby',
     'stripe-7'      => '✅ 2.5 / ✅ 2.6 / ✅ 2.7 / ✅ 3.0 / ✅ 3.1 / ✅ 3.2 / ✅ 3.3 / ✅ 3.4 / ✅ jruby',
+    # TODO: Add stripe-5 and stripe-6
+    'stripe-min'    => '✅ 2.5 / ✅ 2.6 / ✅ 2.7 / ✅ 3.0 / ✅ 3.1 / ✅ 3.2 / ✅ 3.3 / ✅ 3.4 / ✅ jruby', # 5.15.0
   },
   'sucker_punch' => {
     'contrib' => '✅ 2.5 / ✅ 2.6 / ✅ 2.7 / ✅ 3.0 / ✅ 3.1 / ✅ 3.2 / ✅ 3.3 / ✅ 3.4 / ✅ jruby'

appraisal/jruby-9.2.rb

@@ -189,7 +189,7 @@
   gem 'typhoeus'
 end
 
-build_coverage_matrix('stripe', 7..12)
+build_coverage_matrix('stripe', 7..12, min: '5.15.0')
 build_coverage_matrix('opensearch', 2..3, gem: 'opensearch-ruby')
 build_coverage_matrix('elasticsearch', 7..8)
 

appraisal/jruby-9.3.rb

@@ -162,7 +162,7 @@
   gem 'typhoeus'
 end
 
-build_coverage_matrix('stripe', 7..12)
+build_coverage_matrix('stripe', 7..12, min: '5.15.0')
 build_coverage_matrix('opensearch', 2..3, gem: 'opensearch-ruby')
 build_coverage_matrix('elasticsearch', 7..8)
 

appraisal/jruby-9.4.rb

@@ -66,7 +66,7 @@
   gem 'typhoeus'
 end
 
-build_coverage_matrix('stripe', 7..12)
+build_coverage_matrix('stripe', 7..12, min: '5.15.0')
 build_coverage_matrix('opensearch', 2..3, gem: 'opensearch-ruby')
 build_coverage_matrix('elasticsearch', 7..8)
 

appraisal/ruby-2.5.rb

@@ -209,7 +209,7 @@
   gem 'typhoeus'
 end
 
-build_coverage_matrix('stripe', 7..12)
+build_coverage_matrix('stripe', 7..12, min: '5.15.0')
 build_coverage_matrix('opensearch', 2..3, gem: 'opensearch-ruby')
 build_coverage_matrix('elasticsearch', 7..8)
 

appraisal/ruby-2.6.rb

@@ -162,7 +162,7 @@
   gem 'typhoeus'
 end
 
-build_coverage_matrix('stripe', 7..12)
+build_coverage_matrix('stripe', 7..12, min: '5.15.0')
 build_coverage_matrix('opensearch', 2..3, gem: 'opensearch-ruby')
 build_coverage_matrix('elasticsearch', 7..8)
 

appraisal/ruby-2.7.rb

@@ -162,7 +162,7 @@
   gem 'typhoeus'
 end
 
-build_coverage_matrix('stripe', 7..12)
+build_coverage_matrix('stripe', 7..12, min: '5.15.0')
 build_coverage_matrix('opensearch', 2..3, gem: 'opensearch-ruby')
 build_coverage_matrix('elasticsearch', 7..8)
 

appraisal/ruby-3.0.rb

@@ -83,7 +83,7 @@
   gem 'typhoeus'
 end
 
-build_coverage_matrix('stripe', 7..12)
+build_coverage_matrix('stripe', 7..12, min: '5.15.0')
 build_coverage_matrix('opensearch', 2..3, gem: 'opensearch-ruby')
 build_coverage_matrix('elasticsearch', 7..8)
 

appraisal/ruby-3.1.rb

@@ -83,7 +83,7 @@
   gem 'typhoeus'
 end
 
-build_coverage_matrix('stripe', 7..12)
+build_coverage_matrix('stripe', 7..12, min: '5.15.0')
 build_coverage_matrix('opensearch', 2..3, gem: 'opensearch-ruby')
 build_coverage_matrix('elasticsearch', 7..8)
 

appraisal/ruby-3.2.rb

@@ -83,7 +83,7 @@
   gem 'typhoeus'
 end
 
-build_coverage_matrix('stripe', 7..12)
+build_coverage_matrix('stripe', 7..12, min: '5.15.0')
 build_coverage_matrix('opensearch', 2..3, gem: 'opensearch-ruby')
 build_coverage_matrix('elasticsearch', 7..8)
 

appraisal/ruby-3.3.rb

@@ -83,7 +83,7 @@
   gem 'typhoeus'
 end
 
-build_coverage_matrix('stripe', 7..12)
+build_coverage_matrix('stripe', 7..12, min: '5.15.0')
 build_coverage_matrix('opensearch', 2..3, gem: 'opensearch-ruby')
 build_coverage_matrix('elasticsearch', 7..8)
 

appraisal/ruby-3.4.rb

@@ -83,7 +83,7 @@
   gem 'typhoeus'
 end
 
-build_coverage_matrix('stripe', 7..12)
+build_coverage_matrix('stripe', 7..12, min: '5.15.0')
 build_coverage_matrix('opensearch', 2..3, gem: 'opensearch-ruby')
 build_coverage_matrix('elasticsearch', 7..8)