Skip to content

Add support for skipping slow builds and reusing previous results #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Feb 17, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 70 additions & 15 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
name: CRuby Dev Builds
permissions:
contents: write
on:
workflow_dispatch:
inputs:
skip_slow:
type: boolean
default: false
push:
tags:
- '*'
Expand All @@ -11,8 +17,11 @@ jobs:
name: Check if the latest ruby commit is already built
runs-on: ubuntu-latest
outputs:
should_build: ${{ steps.check_commit.outputs.result }}
should_build: ${{ steps.check_commit.outputs.should_build }}
commit: ${{ steps.latest_commit.outputs.commit }}
previous_release: ${{ steps.check_commit.outputs.previous_release }}
build_matrix: ${{ steps.matrix.outputs.build_matrix }}
reuse_matrix: ${{ steps.matrix.outputs.reuse_matrix }}
steps:
- name: Clone ruby
uses: actions/checkout@v4
Expand All @@ -32,15 +41,32 @@ jobs:
const latestDevCommit = "${{ steps.latest_commit.outputs.commit }}"
const { owner, repo } = context.repo
let { data: release } = await github.rest.repos.getLatestRelease({ owner, repo })
const latestReleaseCommit = release.body.split('@')[1]
const firstLine = release.body.split('\n')[0]
const latestReleaseCommit = firstLine.split('@')[1]
console.log(`Latest release commit: ${latestReleaseCommit}`)
console.log(`Latest ruby commit: ${latestDevCommit}`)
if (latestReleaseCommit === latestDevCommit) {
return 'false'
} else {
return 'true'
}
result-encoding: string
core.setOutput('should_build', latestReleaseCommit !== latestDevCommit)
core.setOutput('previous_release', release.tag_name)
- name: Compute build and reuse matrix
uses: actions/github-script@v7
id: matrix
with:
script: |
const osList = ['ubuntu-20.04', 'ubuntu-22.04', 'ubuntu-24.04', 'ubuntu-22.04-arm', 'ubuntu-24.04-arm', 'macos-13', 'macos-14']
const skipSlow = "${{ github.event_name == 'workflow_dispatch' && github.event.inputs.skip_slow == 'true' }}"
const buildMatrix = JSON.stringify(
skipSlow === 'false' ?
{ os: osList, name: ['head', 'debug'], include: [{ os: 'ubuntu-24.04', name: 'asan' }] } :
{ os: osList, name: ['head'] }
)
core.setOutput('build_matrix', buildMatrix)
const reuseMatrix = JSON.stringify(
skipSlow === 'false' ?
{ os: ['ubuntu-latest'], name: ['noop'] } : // GitHub doesn't like having an empty matrix, skips jobs that depend on reuse-slow
{ os: osList, name: ['debug'], include: [{ os: 'ubuntu-24.04', name: 'asan' }] }
)
core.setOutput('reuse_matrix', reuseMatrix)
console.log(`build_matrix: ${buildMatrix}, reuse_matrix: ${reuseMatrix}`)

release:
name: Create GitHub Release
Expand All @@ -64,24 +90,25 @@ jobs:
tag=$(basename "${{ github.ref }}")
fi
echo "tag=$tag" >> $GITHUB_OUTPUT
- name: Set release description to built hash
run: echo "ruby/ruby@${{ needs.prepare.outputs.commit }}" >> release-description.md
- name: Append note if buils were reused
if: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.skip_slow == 'true' }}
run: echo "Skipped building and reused builds from ${{ needs.prepare.outputs.previous_release }} for debug and asan rubies" >> release-description.md
- name: Create Release
env:
GH_TOKEN: ${{ github.token }}
GH_REPO: ${{ github.repository }}
run: |
tag="${{ steps.tag.outputs.tag }}"
body="ruby/ruby@${{ needs.prepare.outputs.commit }}"
gh release create --draft "$tag" --title "$tag" --notes "$body"
gh release create --draft "$tag" --title "$tag" --notes-file release-description.md

build:
needs: [prepare, release]
strategy:
fail-fast: false
matrix:
os: [ ubuntu-20.04, ubuntu-22.04, ubuntu-24.04, ubuntu-22.04-arm, ubuntu-24.04-arm, macos-13, macos-14 ]
name: [ head, debug ]
include:
- { os: ubuntu-24.04, name: asan }
matrix: ${{ fromJson(needs.prepare.outputs.build_matrix) }}
runs-on: ${{ matrix.os }}
steps:
- name: Clone ruby
Expand Down Expand Up @@ -205,9 +232,37 @@ jobs:
GH_REPO: ${{ github.repository }}
run: gh release upload "${{ needs.release.outputs.tag }}" "ruby-${{ matrix.name }}-${{ steps.platform.outputs.platform }}.tar.gz"

reuse-slow:
needs: [prepare, release]
strategy:
fail-fast: false
matrix: ${{ fromJson(needs.prepare.outputs.reuse_matrix) }}
runs-on: ${{ matrix.os }}
env:
GH_TOKEN: ${{ github.token }}
GH_REPO: ${{ github.repository }}
steps:
- name: Set platform
id: platform
run: |
platform=${{ matrix.os }}
platform=${platform/macos-13/macos-latest}
platform=${platform/macos-14/macos-13-arm64}
platform=${platform/%-arm/-arm64}
echo "platform=$platform" >> $GITHUB_OUTPUT
- name: Download binaries from previous release
run: gh release download "${{ needs.prepare.outputs.previous_release }}" --pattern "ruby-${{ matrix.name }}-${{ steps.platform.outputs.platform }}.tar.gz"
if: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.skip_slow == 'true' }}
- name: Re-upload Binaries
run: gh release upload "${{ needs.release.outputs.tag }}" "ruby-${{ matrix.name }}-${{ steps.platform.outputs.platform }}.tar.gz"
if: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.skip_slow == 'true' }}
- name: (Empty step for when reuse is not applied)
run: echo "Not reusing binaries. This step is a no-op." # We can't skip the whole job as publish depends on it, but we skip the uploading
if: ${{ !(github.event_name == 'workflow_dispatch' && github.event.inputs.skip_slow == 'true') }}

publish:
name: Publish Release
needs: [release, build]
needs: [release, build, reuse-slow]
runs-on: ubuntu-latest
steps:
- name: Publish Release
Expand Down