fix: Publish java-specific platform gem

When we originally introduced the zlib dependency, we attempted to
exclude that dependency in jRuby. However, that exclusion is a
build-time check, not run-time as previously though.

To support this, we now publish 2 gems -- the standard gem and the
*-java specific version. The latter of which is now shipped without the
zlib gem requirement.

Author: keelerm84

.github/actions/ci/action.yml renamed to .github/actions/check/action.yml

@@ -1,27 +1,19 @@
-name: CI Workflow
-description: 'Shared CI workflow.'
+name: Quality control checks
+description: 'Runs tests, linters, and contract tests'
 inputs:
-  ruby-version:
-    description: 'The version of ruby to setup and run'
-    required: true
+  flaky:
+    description: 'Is the platform under test considered flaky?'
+    required: false
+    default: 'false'
   token:
     description: 'GH token used to fetch the SDK test harness'
     required: true
 
 runs:
   using: composite
   steps:
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ inputs.ruby-version }}
-        bundler: 2.2.33
-
-    - name: Install dependencies
-      shell: bash
-      run: bundle _2.2.33_ install
-
     - name: Skip flaky tests for jruby
-      if: ${{ startsWith(inputs.ruby-version, 'jruby') }}
+      if: ${{ inputs.flaky == 'true' }}
       shell: bash
       run: echo "SPEC_TAGS=-t '~flaky'" >> $GITHUB_ENV
 
@@ -34,17 +26,17 @@ runs:
       run: bundle exec rubocop --parallel
 
     - name: Build contract tests
-      if: ${{ !startsWith(inputs.ruby-version, 'jruby') }}
+      if: ${{ inputs.flaky != 'true' }}
       shell: bash
       run: make build-contract-tests
 
     - name: Start contract test service
-      if: ${{ !startsWith(inputs.ruby-version, 'jruby') }}
+      if: ${{ inputs.flaky != 'true' }}
       shell: bash
       run: make start-contract-test-service-bg
 
     - uses: launchdarkly/gh-actions/actions/[email protected]
-      if: ${{ !startsWith(inputs.ruby-version, 'jruby') }}
+      if: ${{ inputs.flaky != 'true' }}
       with:
         test_service_port: 9000
         enable_persistence_tests: true

.github/actions/publish-docs/action.yml

@@ -12,4 +12,4 @@ runs:
       name: 'Publish to Github pages'
       with:
         docs_path: docs/build/html/
-        github_token: ${{inputs.token}} # For the shared action the token should be a GITHUB_TOKEN<
+        github_token: ${{ inputs.token }} # For the shared action the token should be a GITHUB_TOKEN<

.github/actions/publish/action.yml

@@ -12,13 +12,14 @@ outputs:
 runs:
   using: composite
   steps:
-    - name: Build gemspec
-      shell: bash
-      run: gem build launchdarkly-server-sdk.gemspec
+    - uses: actions/download-artifact@v4
+      with:
+        name: gems
+        pattern: launchdarkly-server-sdk-*.gem
 
     - name: Hash gem for provenance
       id: gem-hash
-      shell: bash 
+      shell: bash
       run: |
         echo "gem-hash=$(sha256sum launchdarkly-server-sdk-*.gem | base64 -w0)" >> "$GITHUB_OUTPUT"
 

.github/actions/setup/action.yml

@@ -0,0 +1,23 @@
+name: Setup Ruby
+description: 'Install ruby, and optionally the project dependencies'
+inputs:
+  version:
+    description: 'The version of ruby to setup and run'
+    required: true
+  install-dependencies:
+    description: 'Whether to install the project dependencies'
+    required: false
+    default: 'true'
+
+runs:
+  using: composite
+  steps:
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ inputs.version }}
+        bundler: 2.2.33
+
+    - name: Install dependencies
+      if: ${{ inputs.install-dependencies == 'true' }}
+      shell: bash
+      run: bundle _2.2.33_ install

.github/workflows/build-gem.yml

@@ -0,0 +1,53 @@
+name: Build gem
+
+on:
+  workflow_call:
+    inputs:
+      version:
+        description: 'The version of ruby to build against'
+        type: string
+        required: true
+        default: '3.0'
+
+jobs:
+  build-gem:
+    runs-on: ubuntu-latest
+
+    env:
+      LD_SKIP_DATABASE_TESTS: 0
+      BUILD_PLATFORM: ${{ startsWith(inputs.version, 'jruby') && 'jruby' || 'ruby' }}
+      FLAKY: ${{ startsWith(inputs.version, 'jruby') && 'true' || 'false' }}
+
+    services:
+      redis:
+        image: redis
+        ports:
+          - 6379:6379
+      dynamodb:
+        image: amazon/dynamodb-local
+        ports:
+          - 8000:8000
+      consul:
+        image: hashicorp/consul
+        ports:
+          - 8500:8500
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: ./.github/actions/setup
+        with:
+          version: ${{ inputs.version }}
+
+      - uses: ./.github/actions/check
+        with:
+          flaky: ${{ env.FLAKY }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build gemspec (jruby)
+        run: gem build launchdarkly-server-sdk.gemspec --platform=$BUILD_PLATFORM
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: gems
+          path: launchdarkly-server-sdk-*.gem

.github/workflows/ci.yml

@@ -10,47 +10,32 @@ on:
       - '**.md'
 
 jobs:
-  build-linux:
+  build-linux-oldest:
+    uses: ./.github/workflows/build-gem.yml
+    with:
+      version: '3.0'
+
+  build-linux-latest:
+    uses: ./.github/workflows/build-gem.yml
+    with:
+      version: '3.4'
+
+  build-linux-jruby:
+    uses: ./.github/workflows/build-gem.yml
+    with:
+      version: 'jruby-9.4'
+
+  build-docs:
     runs-on: ubuntu-latest
 
-    env:
-      LD_SKIP_DATABASE_TESTS: 0
-
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby-version:
-          - '3.0'
-          - '3.1'
-          - '3.2'
-          - jruby-9.4
-
-    services:
-      redis:
-        image: redis
-        ports:
-          - 6379:6379
-      dynamodb:
-        image: amazon/dynamodb-local
-        ports:
-          - 8000:8000
-      consul:
-        image: hashicorp/consul
-        ports:
-          - 8500:8500
-
     steps:
       - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0 # If you only need the current version keep this.
 
-      - uses: ./.github/actions/ci
+      - uses: ./.github/actions/setup
         with:
-          ruby-version: ${{ matrix.ruby-version }}
-          token: ${{ secrets.GITHUB_TOKEN }}
+          version: 3.0
 
       - uses: ./.github/actions/build-docs
-        if: ${{ !startsWith(matrix.ruby-version, 'jruby') }}
 
   build-windows:
     runs-on: windows-latest
@@ -65,13 +50,9 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - uses: ruby/setup-ruby@v1
+      - uses: ./.github/actions/setup
         with:
-          ruby-version: 3.0
-          bundler: 2.2.33
-
-      - name: Install dependencies
-        run: bundle _2.2.33_ install
+          version: 3.0
 
       - name: Run tests
         run: bundle _2.2.33_ exec rspec spec

.github/workflows/manual-publish-docs.yml

@@ -5,19 +5,20 @@ name: Publish Documentation
 jobs:
   build-publish-docs:
     runs-on: ubuntu-latest
+
     permissions:
-      id-token: write # Needed if using OIDC to get release secrets.
       contents: write # Needed in this case to write github pages.
+
     steps:
       - uses: actions/checkout@v4
 
-      - uses: ruby/setup-ruby@v1
+      - uses: ./.github/actions/setup
         with:
-          ruby-version: 3.0
-          bundler: 2.2.33
+          version: 3.0
+          install-dependencies: false
 
       - uses: ./.github/actions/build-docs
 
       - uses: ./.github/actions/publish-docs
         with:
-          token: ${{secrets.GITHUB_TOKEN}}
+          token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/manual-publish.yml

@@ -8,43 +8,61 @@ on:
         required: true
 
 jobs:
-  build-publish:
+  build-ruby-gem:
+    uses: ./.github/workflows/build-gem.yml
+    with:
+      version: '3.0'
+
+  build-jruby-gem:
+    uses: ./.github/workflows/build-gem.yml
+    with:
+      version: 'jruby-9.4'
+
+  publish:
     runs-on: ubuntu-latest
-    # Needed to get tokens during publishing.
-    permissions:
-      id-token: write
-      contents: read
+    needs: [ 'build-ruby-gem', 'build-jruby-gem' ]
+
     outputs:
-      gem-hash: ${{ steps.publish.outputs.gem-hash}}
+      gem-hash: ${{ steps.publish.outputs.gem-hash }}
+
+    permissions:
+      id-token: write # Needed if using OIDC to get release secrets.
+      contents: write
+
     steps:
-      - uses: actions/checkout@v4
+      - uses: ./.github/actions/setup
+        with:
+          version: 3.0
+          install-dependencies: false
 
       - uses: launchdarkly/gh-actions/actions/[email protected]
         name: 'Get rubygems API key'
         with:
           aws_assume_role: ${{ vars.AWS_ROLE_ARN }}
           ssm_parameter_pairs: '/production/common/releasing/rubygems/api_key = GEM_HOST_API_KEY'
 
-      - id: build-and-test
-        name: Build and Test
-        uses: ./.github/actions/ci
+      - uses: ./.github/actions/build-docs
+
+      - uses: ./.github/actions/publish
+        id: publish
         with:
-          ruby-version: 3.0
-          token: ${{ secrets.GITHUB_TOKEN }}
+          dry_run: ${{ !inputs.dry_run }}
 
-      - id: publish
-        name: Publish Package
-        uses: ./.github/actions/publish
+      - uses: ./.github/actions/publish-docs
+        if: ${{ !inputs.dry_run }}
         with:
-          dry_run: ${{ inputs.dry_run }}
+          token: ${{secrets.GITHUB_TOKEN}}
 
   release-provenance:
-    needs: [ 'build-publish' ]
+    needs: [ 'publish' ]
+    if: ${{ needs.release-package.outputs.release-created == 'true' }}
+
     permissions:
       actions: read
       id-token: write
       contents: write
+
     uses: slsa-framework/slsa-github-generator/.github/workflows/[email protected]
     with:
-      base64-subjects: "${{ needs.build-publish.outputs.gem-hash }}"
-      upload-assets: ${{ !inputs.dry_run }}
+      base64-subjects: "${{ needs.publish.outputs.gem-hash }}"
+      upload-assets: true