Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 2ab2187

Browse files
keelerm84keelerm84
committedFeb 7, 2025·
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.
1 parent 41d3abb commit 2ab2187

File tree

9 files changed

+199
-104
lines changed

9 files changed

+199
-104
lines changed
 

‎.github/actions/ci/action.yml ‎.github/actions/check/action.yml

+10-18
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,19 @@
1-
name: CI Workflow
2-
description: 'Shared CI workflow.'
1+
name: Quality control checks
2+
description: 'Runs tests, linters, and contract tests'
33
inputs:
4-
ruby-version:
5-
description: 'The version of ruby to setup and run'
6-
required: true
4+
flaky:
5+
description: 'Is the platform under test considered flaky?'
6+
required: false
7+
default: 'false'
78
token:
89
description: 'GH token used to fetch the SDK test harness'
910
required: true
1011

1112
runs:
1213
using: composite
1314
steps:
14-
- uses: ruby/setup-ruby@v1
15-
with:
16-
ruby-version: ${{ inputs.ruby-version }}
17-
bundler: 2.2.33
18-
19-
- name: Install dependencies
20-
shell: bash
21-
run: bundle _2.2.33_ install
22-
2315
- name: Skip flaky tests for jruby
24-
if: ${{ startsWith(inputs.ruby-version, 'jruby') }}
16+
if: ${{ inputs.flaky == 'true' }}
2517
shell: bash
2618
run: echo "SPEC_TAGS=-t '~flaky'" >> $GITHUB_ENV
2719

@@ -34,17 +26,17 @@ runs:
3426
run: bundle exec rubocop --parallel
3527

3628
- name: Build contract tests
37-
if: ${{ !startsWith(inputs.ruby-version, 'jruby') }}
29+
if: ${{ inputs.flaky != 'true' }}
3830
shell: bash
3931
run: make build-contract-tests
4032

4133
- name: Start contract test service
42-
if: ${{ !startsWith(inputs.ruby-version, 'jruby') }}
34+
if: ${{ inputs.flaky != 'true' }}
4335
shell: bash
4436
run: make start-contract-test-service-bg
4537

4638
- uses: launchdarkly/gh-actions/actions/contract-tests@contract-tests-v1.2.0
47-
if: ${{ !startsWith(inputs.ruby-version, 'jruby') }}
39+
if: ${{ inputs.flaky != 'true' }}
4840
with:
4941
test_service_port: 9000
5042
enable_persistence_tests: true

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ runs:
1212
name: 'Publish to Github pages'
1313
with:
1414
docs_path: docs/build/html/
15-
github_token: ${{inputs.token}} # For the shared action the token should be a GITHUB_TOKEN<
15+
github_token: ${{ inputs.token }} # For the shared action the token should be a GITHUB_TOKEN<

‎.github/actions/publish/action.yml

+5-4
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,14 @@ outputs:
1212
runs:
1313
using: composite
1414
steps:
15-
- name: Build gemspec
16-
shell: bash
17-
run: gem build launchdarkly-server-sdk.gemspec
15+
- uses: actions/download-artifact@v4
16+
with:
17+
name: gems
18+
pattern: launchdarkly-server-sdk-*.gem
1819

1920
- name: Hash gem for provenance
2021
id: gem-hash
21-
shell: bash
22+
shell: bash
2223
run: |
2324
echo "gem-hash=$(sha256sum launchdarkly-server-sdk-*.gem | base64 -w0)" >> "$GITHUB_OUTPUT"
2425

‎.github/actions/setup/action.yml

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Setup Ruby
2+
description: 'Install ruby, and optionally the project dependencies'
3+
inputs:
4+
version:
5+
description: 'The version of ruby to setup and run'
6+
required: true
7+
install-dependencies:
8+
description: 'Whether to install the project dependencies'
9+
required: false
10+
default: 'true'
11+
12+
runs:
13+
using: composite
14+
steps:
15+
- uses: ruby/setup-ruby@v1
16+
with:
17+
ruby-version: ${{ inputs.version }}
18+
bundler: 2.2.33
19+
20+
- name: Install dependencies
21+
if: ${{ inputs.install-dependencies == 'true' }}
22+
shell: bash
23+
run: bundle _2.2.33_ install

‎.github/workflows/build-gem.yml

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: Build gem
2+
3+
on:
4+
workflow_call:
5+
inputs:
6+
version:
7+
description: 'The version of ruby to build against'
8+
type: string
9+
default: '3.0'
10+
upload-artifact:
11+
description: 'Whether to upload the gem as an artifact'
12+
type: boolean
13+
required: false
14+
default: true
15+
16+
jobs:
17+
build-gem:
18+
runs-on: ubuntu-latest
19+
20+
env:
21+
LD_SKIP_DATABASE_TESTS: 0
22+
BUILD_PLATFORM: ${{ startsWith(inputs.version, 'jruby') && 'jruby' || 'ruby' }}
23+
FLAKY: ${{ startsWith(inputs.version, 'jruby') && 'true' || 'false' }}
24+
25+
services:
26+
redis:
27+
image: redis
28+
ports:
29+
- 6379:6379
30+
dynamodb:
31+
image: amazon/dynamodb-local
32+
ports:
33+
- 8000:8000
34+
consul:
35+
image: hashicorp/consul
36+
ports:
37+
- 8500:8500
38+
39+
steps:
40+
- uses: actions/checkout@v4
41+
42+
- uses: ./.github/actions/setup
43+
with:
44+
version: ${{ inputs.version }}
45+
46+
- uses: ./.github/actions/check
47+
with:
48+
flaky: ${{ env.FLAKY }}
49+
token: ${{ secrets.GITHUB_TOKEN }}
50+
51+
- name: Build gemspec (jruby)
52+
run: gem build launchdarkly-server-sdk.gemspec --platform=$BUILD_PLATFORM
53+
54+
- uses: actions/upload-artifact@v4
55+
if: ${{ inputs.upload-artifact }}
56+
with:
57+
name: gems
58+
path: launchdarkly-server-sdk-*.gem

‎.github/workflows/ci.yml

+21-39
Original file line numberDiff line numberDiff line change
@@ -10,47 +10,33 @@ on:
1010
- '**.md'
1111

1212
jobs:
13-
build-linux:
13+
build-linux-oldest:
14+
uses: ./.github/workflows/build-gem.yml
15+
with:
16+
version: '3.0'
17+
18+
build-linux-latest:
19+
uses: ./.github/workflows/build-gem.yml
20+
with:
21+
version: '3.2'
22+
upload-artifact: false
23+
24+
build-linux-jruby:
25+
uses: ./.github/workflows/build-gem.yml
26+
with:
27+
version: 'jruby-9.4'
28+
29+
build-docs:
1430
runs-on: ubuntu-latest
1531

16-
env:
17-
LD_SKIP_DATABASE_TESTS: 0
18-
19-
strategy:
20-
fail-fast: false
21-
matrix:
22-
ruby-version:
23-
- '3.0'
24-
- '3.1'
25-
- '3.2'
26-
- jruby-9.4
27-
28-
services:
29-
redis:
30-
image: redis
31-
ports:
32-
- 6379:6379
33-
dynamodb:
34-
image: amazon/dynamodb-local
35-
ports:
36-
- 8000:8000
37-
consul:
38-
image: hashicorp/consul
39-
ports:
40-
- 8500:8500
41-
4232
steps:
4333
- uses: actions/checkout@v4
44-
with:
45-
fetch-depth: 0 # If you only need the current version keep this.
4634

47-
- uses: ./.github/actions/ci
35+
- uses: ./.github/actions/setup
4836
with:
49-
ruby-version: ${{ matrix.ruby-version }}
50-
token: ${{ secrets.GITHUB_TOKEN }}
37+
version: '3.0'
5138

5239
- uses: ./.github/actions/build-docs
53-
if: ${{ !startsWith(matrix.ruby-version, 'jruby') }}
5440

5541
build-windows:
5642
runs-on: windows-latest
@@ -65,13 +51,9 @@ jobs:
6551
steps:
6652
- uses: actions/checkout@v4
6753

68-
- uses: ruby/setup-ruby@v1
54+
- uses: ./.github/actions/setup
6955
with:
70-
ruby-version: 3.0
71-
bundler: 2.2.33
72-
73-
- name: Install dependencies
74-
run: bundle _2.2.33_ install
56+
version: '3.0'
7557

7658
- name: Run tests
7759
run: bundle _2.2.33_ exec rspec spec

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

+6-5
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,20 @@ name: Publish Documentation
55
jobs:
66
build-publish-docs:
77
runs-on: ubuntu-latest
8+
89
permissions:
9-
id-token: write # Needed if using OIDC to get release secrets.
1010
contents: write # Needed in this case to write github pages.
11+
1112
steps:
1213
- uses: actions/checkout@v4
1314

14-
- uses: ruby/setup-ruby@v1
15+
- uses: ./.github/actions/setup
1516
with:
16-
ruby-version: 3.0
17-
bundler: 2.2.33
17+
version: '3.0'
18+
install-dependencies: false
1819

1920
- uses: ./.github/actions/build-docs
2021

2122
- uses: ./.github/actions/publish-docs
2223
with:
23-
token: ${{secrets.GITHUB_TOKEN}}
24+
token: ${{ secrets.GITHUB_TOKEN }}

‎.github/workflows/manual-publish.yml

+37-19
Original file line numberDiff line numberDiff line change
@@ -8,43 +8,61 @@ on:
88
required: true
99

1010
jobs:
11-
build-publish:
11+
build-ruby-gem:
12+
uses: ./.github/workflows/build-gem.yml
13+
with:
14+
version: '3.0'
15+
16+
build-jruby-gem:
17+
uses: ./.github/workflows/build-gem.yml
18+
with:
19+
version: 'jruby-9.4'
20+
21+
publish:
1222
runs-on: ubuntu-latest
13-
# Needed to get tokens during publishing.
14-
permissions:
15-
id-token: write
16-
contents: read
23+
needs: [ 'build-ruby-gem', 'build-jruby-gem' ]
24+
1725
outputs:
18-
gem-hash: ${{ steps.publish.outputs.gem-hash}}
26+
gem-hash: ${{ steps.publish.outputs.gem-hash }}
27+
28+
permissions:
29+
id-token: write # Needed if using OIDC to get release secrets.
30+
contents: write
31+
1932
steps:
20-
- uses: actions/checkout@v4
33+
- uses: ./.github/actions/setup
34+
with:
35+
version: '3.0'
36+
install-dependencies: false
2137

2238
- uses: launchdarkly/gh-actions/actions/release-secrets@release-secrets-v1.2.0
2339
name: 'Get rubygems API key'
2440
with:
2541
aws_assume_role: ${{ vars.AWS_ROLE_ARN }}
2642
ssm_parameter_pairs: '/production/common/releasing/rubygems/api_key = GEM_HOST_API_KEY'
2743

28-
- id: build-and-test
29-
name: Build and Test
30-
uses: ./.github/actions/ci
44+
- uses: ./.github/actions/build-docs
45+
46+
- uses: ./.github/actions/publish
47+
id: publish
3148
with:
32-
ruby-version: 3.0
33-
token: ${{ secrets.GITHUB_TOKEN }}
49+
dry_run: ${{ !inputs.dry_run }}
3450

35-
- id: publish
36-
name: Publish Package
37-
uses: ./.github/actions/publish
51+
- uses: ./.github/actions/publish-docs
52+
if: ${{ !inputs.dry_run }}
3853
with:
39-
dry_run: ${{ inputs.dry_run }}
54+
token: ${{secrets.GITHUB_TOKEN}}
4055

4156
release-provenance:
42-
needs: [ 'build-publish' ]
57+
needs: [ 'publish' ]
58+
if: ${{ needs.release-package.outputs.release-created == 'true' }}
59+
4360
permissions:
4461
actions: read
4562
id-token: write
4663
contents: write
64+
4765
uses: slsa-framework/slsa-github-generator/.github/workflows/generator_generic_slsa3.yml@v2.0.0
4866
with:
49-
base64-subjects: "${{ needs.build-publish.outputs.gem-hash }}"
50-
upload-assets: ${{ !inputs.dry_run }}
67+
base64-subjects: "${{ needs.publish.outputs.gem-hash }}"
68+
upload-assets: true

‎.github/workflows/release-please.yml

+38-18
Original file line numberDiff line numberDiff line change
@@ -8,59 +8,79 @@ on:
88
jobs:
99
release-package:
1010
runs-on: ubuntu-latest
11+
1112
permissions:
12-
id-token: write # Needed if using OIDC to get release secrets.
1313
contents: write # Contents and pull-requests are for release-please to make releases.
1414
pull-requests: write
15+
1516
outputs:
1617
release-created: ${{ steps.release.outputs.release_created }}
1718
upload-tag-name: ${{ steps.release.outputs.tag_name }}
18-
gem-hash: ${{ steps.publish.outputs.gem-hash}}
19+
1920
steps:
2021
- uses: googleapis/release-please-action@v4
2122
id: release
2223

23-
- uses: actions/checkout@v4
24-
if: ${{ steps.release.outputs.releases_created == 'true' }}
24+
build-ruby-gem:
25+
needs: [ 'release-package' ]
26+
if: ${{ needs.release-package.outputs.release-created == 'true' }}
27+
uses: ./.github/workflows/build-gem.yml
28+
with:
29+
platform: 'ruby'
30+
31+
build-jruby-gem:
32+
needs: [ 'release-package' ]
33+
if: ${{ needs.release-package.outputs.release-created == 'true' }}
34+
uses: ./.github/workflows/build-gem.yml
35+
with:
36+
platform: 'jruby'
37+
38+
publish:
39+
runs-on: ubuntu-latest
40+
needs: [ 'release-package', 'build-ruby-gem', 'build-jruby-gem' ]
41+
if: ${{ needs.release-package.outputs.release-created == 'true' }}
42+
43+
outputs:
44+
gem-hash: ${{ steps.publish.outputs.gem-hash }}
45+
46+
permissions:
47+
id-token: write # Needed if using OIDC to get release secrets.
48+
contents: write # Contents and pull-requests are for release-please to make releases.
49+
50+
steps:
51+
- uses: ./.github/actions/setup
2552
with:
26-
fetch-depth: 0 # If you only need the current version keep this.
53+
version: '3.0'
54+
install-dependencies: false
2755

2856
- uses: launchdarkly/gh-actions/actions/release-secrets@release-secrets-v1.2.0
29-
if: ${{ steps.release.outputs.releases_created == 'true' }}
3057
name: 'Get rubygems API key'
3158
with:
3259
aws_assume_role: ${{ vars.AWS_ROLE_ARN }}
3360
ssm_parameter_pairs: '/production/common/releasing/rubygems/api_key = GEM_HOST_API_KEY'
3461

35-
- uses: ./.github/actions/ci
36-
if: ${{ steps.release.outputs.releases_created == 'true' }}
37-
with:
38-
ruby-version: 3.0
39-
token: ${{ secrets.GITHUB_TOKEN }}
40-
4162
- uses: ./.github/actions/build-docs
42-
if: ${{ steps.release.outputs.releases_created == 'true' }}
4363

4464
- uses: ./.github/actions/publish
4565
id: publish
46-
if: ${{ steps.release.outputs.releases_created == 'true' }}
4766
with:
4867
dry_run: false
4968

5069
- uses: ./.github/actions/publish-docs
51-
if: ${{ steps.release.outputs.releases_created == 'true' }}
5270
with:
53-
token: ${{secrets.GITHUB_TOKEN}}
71+
token: ${{ secrets.GITHUB_TOKEN }}
5472

5573
release-provenance:
56-
needs: [ 'release-package' ]
74+
needs: [ 'release-package', 'publish' ]
5775
if: ${{ needs.release-package.outputs.release-created == 'true' }}
76+
5877
permissions:
5978
actions: read
6079
id-token: write
6180
contents: write
81+
6282
uses: slsa-framework/slsa-github-generator/.github/workflows/generator_generic_slsa3.yml@v2.0.0
6383
with:
64-
base64-subjects: "${{ needs.release-package.outputs.gem-hash }}"
84+
base64-subjects: "${{ needs.publish.outputs.gem-hash }}"
6585
upload-assets: true
6686
upload-tag-name: ${{ needs.release-package.outputs.upload-tag-name }}

0 commit comments

Comments
 (0)
Please sign in to comment.