Run workers-sdk tests on PRs (#3385) #2257
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Build & Release | |
| on: | |
| push: | |
| branches: | |
| - main | |
| workflow_dispatch: | |
| inputs: | |
| patch: | |
| description: 'Patch Version' | |
| required: true | |
| default: '0' | |
| prerelease: | |
| description: 'Is Prerelease' | |
| type: boolean | |
| default: false | |
| jobs: | |
| version: | |
| outputs: | |
| date: ${{ steps.echo.outputs.date }} | |
| version: ${{ steps.echo.outputs.version }} | |
| types_version: ${{ steps.echo.outputs.types_version }} | |
| # version job uses ubuntu 24.04, this way we don't have to install the updated clang while | |
| # the build job uses 22.04 for libc compatibility. | |
| runs-on: ubuntu-24.04 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - id: echo | |
| run: | | |
| echo "date=$(cat src/workerd/io/supported-compatibility-date.txt)" >> $GITHUB_OUTPUT; | |
| echo "version=${{ (github.event_name != 'push' && inputs.prerelease == true) && '0' || '1'}}.$(cat src/workerd/io/supported-compatibility-date.txt | tr -d '-').${{ github.event_name == 'push' && '0' || inputs.patch }}" >> $GITHUB_OUTPUT; | |
| echo "types_version=${{ (github.event_name != 'push' && inputs.prerelease == true) && '0' || '4'}}.$(cat src/workerd/io/supported-compatibility-date.txt | tr -d '-').${{ github.event_name == 'push' && '0' || inputs.patch }}" >> $GITHUB_OUTPUT; | |
| check-tag: | |
| name: Check tag is new | |
| outputs: | |
| exists: ${{ steps.check_tag.outputs.exists }} | |
| needs: [version] | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout Repo | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - uses: mukunku/tag-exists-action@v1.6.0 | |
| id: check_tag | |
| with: | |
| tag: v${{ needs.version.outputs.version }} | |
| tag-and-release: | |
| name: Tag & Release | |
| outputs: | |
| upload_url: ${{ steps.create_release.outputs.upload_url }} | |
| needs: [check-tag, version] | |
| runs-on: ubuntu-latest | |
| if: ${{ needs.check-tag.outputs.exists != 'true' }} | |
| steps: | |
| - name: Checkout Repo | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - run: git tag v${{ needs.version.outputs.version }} && git push origin v${{ needs.version.outputs.version }} | |
| - uses: ncipollo/release-action@v1 | |
| id: create_release | |
| with: | |
| generateReleaseNotes: true | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| tag: v${{ needs.version.outputs.version }} | |
| build: | |
| strategy: | |
| matrix: | |
| os: [ubuntu-22.04, macos-15, windows-2022] | |
| target-arch: [ X64 ] | |
| include: | |
| - os-name: linux | |
| os: ubuntu-22.04 | |
| bazel-config: release_linux | |
| - os-name: linux-arm64 | |
| os: ubuntu-22.04-arm | |
| bazel-config: release_linux | |
| target-arch: ARM64 | |
| # Based on runner availability, we build both Apple Silicon and (cross-compiled) x86 | |
| # release binaries on the macos-15 runner. | |
| - os-name: macOS-x64 | |
| # This configuration is used for cross-compiling – macos-15 is Apple Silicon-based but | |
| # we use it to compile the x64 release. | |
| os: macos-15 | |
| bazel-config: release_macos_cross_x86_64 | |
| - os-name: macOS-arm64 | |
| os: macos-15 | |
| bazel-config: release_macos | |
| target-arch: ARM64 | |
| - os-name: windows | |
| os: windows-2022 | |
| bazel-config: release_windows | |
| runs-on: ${{ matrix.os }} | |
| name: build (${{ matrix.os-name }}) | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| show-progress: false | |
| - name: Cache | |
| id: cache | |
| uses: actions/cache@v4 | |
| with: | |
| path: ~/bazel-disk-cache | |
| # Use a different cache key than for tests here, otherwise the release cache could end up | |
| # being used for test builds, where it provides little benefit. | |
| key: bazel-disk-cache-release-${{ runner.os }}-${{ runner.arch }}-${{ hashFiles('.bazelversion', '.bazelrc', 'WORKSPACE') }} | |
| - name: Setup Linux | |
| if: runner.os == 'Linux' | |
| run: | | |
| export DEBIAN_FRONTEND=noninteractive | |
| wget https://apt.llvm.org/llvm.sh | |
| sed -i '/apt-get install/d' llvm.sh | |
| chmod +x llvm.sh | |
| sudo ./llvm.sh 16 | |
| sudo apt-get install -y --no-install-recommends clang-16 lld-16 libunwind-16 libc++abi1-16 libc++1-16 libc++-16-dev | |
| echo "build:linux --action_env=CC=/usr/lib/llvm-16/bin/clang --action_env=CXX=/usr/lib/llvm-16/bin/clang++" >> .bazelrc | |
| echo "build:linux --host_action_env=CC=/usr/lib/llvm-16/bin/clang --host_action_env=CXX=/usr/lib/llvm-16/bin/clang++" >> .bazelrc | |
| - name: Setup macOS | |
| if: runner.os == 'macOS' | |
| run: | | |
| # Install lld and link it to /usr/local/bin. We overwrite any existing link, which may | |
| # exist from an older pre-installed LLVM version on the runner image. | |
| brew install lld | |
| sudo ln -s -f $(brew --prefix lld)/bin/ld64.lld /usr/local/bin/ld64.lld | |
| # Enable lld identical code folding to significantly reduce binary size. | |
| echo "build:macos --config=macos_lld_icf" >> .bazelrc | |
| - name: Setup Windows | |
| if: runner.os == 'Windows' | |
| run: | | |
| git config --global core.symlinks true | |
| git config --system core.longpaths true | |
| git config --show-scope --show-origin core.symlinks | |
| # Set a custom output root directory to avoid long file name issues. | |
| [System.IO.File]::WriteAllLines((Join-Path -Path $env:USERPROFILE -ChildPath '.bazelrc'), 'startup --output_user_root=\\\\?\\C:\\tmp') | |
| - name: Configure download mirrors | |
| shell: bash | |
| run: | | |
| if [ ! -z "${{ secrets.WORKERS_MIRROR_URL }}" ] ; then | |
| # Strip comment in front of WORKERS_MIRROR_URL, then substitute secret to use it. | |
| sed -e '/WORKERS_MIRROR_URL/ { s@# *@@; s@WORKERS_MIRROR_URL@${{ secrets.WORKERS_MIRROR_URL }}@; }' -i.bak WORKSPACE | |
| fi | |
| - name: Bazel build | |
| # Strip debug info here – we don't generate debug info but some is pulled in from external | |
| # static libraries, for example the Rust STL. This is equivalent to the -Wl,-S linker | |
| # option, symbols will not be removed. | |
| run: | | |
| bazel build --disk_cache=~/bazel-disk-cache --strip=always --remote_cache=https://bazel:${{ secrets.BAZEL_CACHE_KEY }}@bazel-remote-cache.devprod.cloudflare.dev --config=ci --config=${{ matrix.bazel-config }} //src/workerd/server:workerd | |
| - name: Upload binary | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: ${{ runner.os }}-${{ matrix.target-arch }}-binary | |
| path: bazel-bin/src/workerd/server/workerd${{ runner.os == 'Windows' && '.exe' || '' }} | |
| upload-artifacts: | |
| name: Upload Artifacts | |
| needs: [version, tag-and-release, build] | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| arch: [linux-64, darwin-64, windows-64] | |
| # This variable itself is unused, but allows us to set up two macOS builds. arm64 builds for | |
| # other platforms will be supported later, then we'll list both architectures here. | |
| cpu: [ X64 ] | |
| include: | |
| - arch: linux-64 | |
| name: Linux-X64 | |
| - arch: linux-arm64 | |
| name: Linux-ARM64 | |
| cpu: ARM64 | |
| - arch: darwin-64 | |
| name: macOS-X64 | |
| - arch: darwin-arm64 | |
| name: macOS-ARM64 | |
| cpu: ARM64 | |
| - arch: windows-64 | |
| name: Windows-X64 | |
| steps: | |
| - name: Checkout Repo | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Download ${{ matrix.name }} | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: ${{ matrix.name }}-binary | |
| path: /tmp | |
| # Set execute permissions before compressing the binary | |
| - if: matrix.arch != 'windows-64' | |
| run: chmod +x /tmp/workerd | |
| - name: Compress release binary | |
| run: | | |
| # As of release v1.20230404.0 the Linux x64 binary after debug_strip is 65.8 MB, | |
| # 21.0 MB with gzip and 17.3 MB with brotli -9. Use gzip as a widely supported format | |
| # which still produces an acceptable compressed size. | |
| gzip -9N -k /tmp/workerd${{ matrix.arch == 'windows-64' && '.exe' || '' }} | |
| - run: mv /tmp/workerd${{ matrix.arch == 'windows-64' && '.exe' || '' }}.gz /tmp/workerd-${{ matrix.arch }}.gz | |
| # Upload compressed release binaries – one set of artifacts is sufficient with gzip being | |
| # widely supported | |
| - name: Upload Release Assets | |
| id: upload-release-asset | |
| uses: actions/upload-release-asset@v1 | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| with: | |
| upload_url: ${{ needs.tag-and-release.outputs.upload_url }} | |
| asset_path: /tmp/workerd-${{ matrix.arch }}.gz | |
| asset_name: workerd-${{ matrix.arch }}.gz | |
| asset_content_type: application/gzip | |
| # Upload release to npm | |
| - name: Use Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: 18 | |
| - name: Modify package.json version | |
| run: node npm/scripts/bump-version.mjs npm/workerd-${{ matrix.arch }}/package.json | |
| env: | |
| WORKERD_VERSION: ${{ needs.version.outputs.version }} | |
| LATEST_COMPATIBILITY_DATE: ${{ needs.version.outputs.date }} | |
| - run: mkdir npm/workerd-${{ matrix.arch }}/bin | |
| - run: cp /tmp/workerd${{ matrix.arch == 'windows-64' && '.exe' || '' }} npm/workerd-${{ matrix.arch }}/bin/workerd${{ matrix.arch == 'windows-64' && '.exe' || '' }} | |
| - run: echo '//registry.npmjs.org/:_authToken=${NPM_TOKEN}' > npm/workerd-${{ matrix.arch }}/.npmrc | |
| - run: cd npm/workerd-${{ matrix.arch }} && npm publish --access public --tag ${{ startsWith(needs.version.outputs.version, '0') && 'beta' || 'latest'}} | |
| env: | |
| NPM_TOKEN: ${{ secrets.NPM_ACCESS_TOKEN }} | |
| miniflare-test: | |
| name: Run Miniflare tests | |
| needs: [build] | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout workers-sdk | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: cloudflare/workers-sdk | |
| - name: Install pnpm | |
| uses: pnpm/action-setup@v4 | |
| - name: Use Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: lts/* | |
| cache: "pnpm" | |
| - name: Install workers-sdk dependencies | |
| run: pnpm install | |
| - name: Download workerd binary | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: Linux-X64-binary | |
| path: /tmp | |
| - name: Make workerd binary executable | |
| run: chmod +x /tmp/workerd | |
| - name: Build Miniflare and dependencies | |
| run: pnpm turbo build --filter miniflare | |
| - name: Run Miniflare tests | |
| run: pnpm --filter miniflare test | |
| env: | |
| MINIFLARE_WORKERD_PATH: /tmp/workerd | |
| publish-wrapper: | |
| name: Publish `workerd` to NPM | |
| needs: [version, upload-artifacts] | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - name: Checkout Repo | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Use Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: 18 | |
| - name: Cache | |
| id: cache | |
| uses: actions/cache@v4 | |
| # Use same cache and build configuration as release build, this allows us to keep download | |
| # sizes small and generate types with optimization enabled, should be slightly faster. | |
| with: | |
| path: ~/bazel-disk-cache | |
| key: bazel-disk-cache-release-${{ runner.os }}-${{ runner.arch }}-${{ hashFiles('.bazelversion', '.bazelrc', 'WORKSPACE') }} | |
| - name: Setup Linux | |
| run: | | |
| export DEBIAN_FRONTEND=noninteractive | |
| wget https://apt.llvm.org/llvm.sh | |
| sed -i '/apt-get install/d' llvm.sh | |
| chmod +x llvm.sh | |
| sudo ./llvm.sh 16 | |
| sudo apt-get install -y --no-install-recommends clang-16 lld-16 libunwind-16 libc++abi1-16 libc++1-16 libc++-16-dev | |
| echo "build:linux --action_env=CC=/usr/lib/llvm-16/bin/clang --action_env=CXX=/usr/lib/llvm-16/bin/clang++" >> .bazelrc | |
| echo "build:linux --host_action_env=CC=/usr/lib/llvm-16/bin/clang --host_action_env=CXX=/usr/lib/llvm-16/bin/clang++" >> .bazelrc | |
| - name: Build type generating Worker | |
| run: | | |
| bazel build --disk_cache=~/bazel-disk-cache --strip=always --remote_cache=https://bazel:${{ secrets.BAZEL_CACHE_KEY }}@bazel-remote-cache.devprod.cloudflare.dev --config=ci --config=release_linux //types:types_worker | |
| - name: Modify package.json version | |
| run: node npm/scripts/bump-version.mjs npm/workerd/package.json | |
| env: | |
| WORKERD_VERSION: ${{ needs.version.outputs.version }} | |
| LATEST_COMPATIBILITY_DATE: ${{ needs.version.outputs.date }} | |
| - run: mkdir -p npm/workerd/lib | |
| - run: mkdir -p npm/workerd/bin | |
| - name: Build node-install | |
| run: npx esbuild npm/lib/node-install.ts --outfile=npm/workerd/install.js --bundle --target=node18 --define:LATEST_COMPATIBILITY_DATE="\"${LATEST_COMPATIBILITY_DATE}\"" --define:WORKERD_VERSION="\"${WORKERD_VERSION}\"" --platform=node --external:workerd --log-level=warning | |
| env: | |
| WORKERD_VERSION: ${{ needs.version.outputs.version }} | |
| LATEST_COMPATIBILITY_DATE: ${{ needs.version.outputs.date }} | |
| - name: Build node-shim | |
| run: npx esbuild npm/lib/node-shim.ts --outfile=npm/workerd/bin/workerd --bundle --target=node18 --define:LATEST_COMPATIBILITY_DATE="\"${LATEST_COMPATIBILITY_DATE}\"" --define:WORKERD_VERSION="\"${WORKERD_VERSION}\"" --platform=node --external:workerd --log-level=warning | |
| env: | |
| WORKERD_VERSION: ${{ needs.version.outputs.version }} | |
| LATEST_COMPATIBILITY_DATE: ${{ needs.version.outputs.date }} | |
| - name: Build node-path | |
| run: npx esbuild npm/lib/node-path.ts --outfile=npm/workerd/lib/main.js --bundle --target=node18 --define:LATEST_COMPATIBILITY_DATE="\"${LATEST_COMPATIBILITY_DATE}\"" --define:WORKERD_VERSION="\"${WORKERD_VERSION}\"" --platform=node --external:workerd --log-level=warning | |
| env: | |
| WORKERD_VERSION: ${{ needs.version.outputs.version }} | |
| LATEST_COMPATIBILITY_DATE: ${{ needs.version.outputs.date }} | |
| - name: Build package | |
| run: node npm/scripts/build-shim-package.mjs | |
| env: | |
| WORKERD_VERSION: ${{ needs.version.outputs.version }} | |
| LATEST_COMPATIBILITY_DATE: ${{ needs.version.outputs.date }} | |
| - run: echo '//registry.npmjs.org/:_authToken=${NPM_TOKEN}' > npm/workerd/.npmrc | |
| - run: cd npm/workerd && npm publish --access public --tag ${{ startsWith(needs.version.outputs.version, '0') && 'beta' || 'latest'}} | |
| env: | |
| NPM_TOKEN: ${{ secrets.NPM_ACCESS_TOKEN }} | |
| build-and-publish-types: | |
| runs-on: ubuntu-22.04 | |
| needs: [version, upload-artifacts] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| show-progress: false | |
| - name: Cache | |
| id: cache | |
| uses: actions/cache@v4 | |
| # Use same cache and build configuration as release build, this allows us to keep download | |
| # sizes small and generate types with optimization enabled, should be slightly faster. | |
| with: | |
| path: ~/bazel-disk-cache | |
| key: bazel-disk-cache-release-${{ runner.os }}-${{ runner.arch }}-${{ hashFiles('.bazelversion', '.bazelrc', 'WORKSPACE') }} | |
| - name: Setup Linux | |
| run: | | |
| export DEBIAN_FRONTEND=noninteractive | |
| wget https://apt.llvm.org/llvm.sh | |
| sed -i '/apt-get install/d' llvm.sh | |
| chmod +x llvm.sh | |
| sudo ./llvm.sh 16 | |
| sudo apt-get install -y --no-install-recommends clang-16 lld-16 libunwind-16 libc++abi1-16 libc++1-16 libc++-16-dev | |
| echo "build:linux --action_env=CC=/usr/lib/llvm-16/bin/clang --action_env=CXX=/usr/lib/llvm-16/bin/clang++" >> .bazelrc | |
| echo "build:linux --host_action_env=CC=/usr/lib/llvm-16/bin/clang --host_action_env=CXX=/usr/lib/llvm-16/bin/clang++" >> .bazelrc | |
| - name: build types | |
| run: | | |
| bazel build --disk_cache=~/bazel-disk-cache --strip=always --remote_cache=https://bazel:${{ secrets.BAZEL_CACHE_KEY }}@bazel-remote-cache.devprod.cloudflare.dev --config=ci --config=release_linux //types:types | |
| - name: Build package | |
| run: node npm/scripts/build-types-package.mjs | |
| env: | |
| WORKERD_VERSION: ${{ needs.version.outputs.types_version }} | |
| LATEST_COMPATIBILITY_DATE: ${{ needs.version.outputs.date }} | |
| - run: cp -r bazel-bin/types/definitions/. npm/workers-types | |
| - run: cp npm/workers-types/oldest/* npm/workers-types | |
| - run: echo '//registry.npmjs.org/:_authToken=${NPM_TOKEN}' > npm/workers-types/.npmrc | |
| - run: cd npm/workers-types && npm publish --access public --tag ${{ startsWith(needs.version.outputs.version, '0') && 'beta' || 'latest'}} | |
| env: | |
| NPM_TOKEN: ${{ secrets.NPM_ACCESS_TOKEN }} | |