From 1069df3cd1c3d44dc56377297b51d55eb81f19bc Mon Sep 17 00:00:00 2001 From: Bart Brouns Date: Wed, 3 Apr 2024 18:05:00 +0200 Subject: [PATCH] add automated builds --- .github/workflows/build.yml | 106 +++++++++++++++++++++++++++ .github/workflows/readme-Linux.txt | 10 +++ .github/workflows/readme-Windows.txt | 10 +++ .github/workflows/readme-macOS.txt | 15 ++++ 4 files changed, 141 insertions(+) create mode 100644 .github/workflows/build.yml create mode 100644 .github/workflows/readme-Linux.txt create mode 100644 .github/workflows/readme-Windows.txt create mode 100644 .github/workflows/readme-macOS.txt diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..96eddb1 --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,106 @@ +name: Automated Builds + +# sligtly adapted from: +# https://github.com/robbert-vdh/nih-plug/blob/master/.github/workflows/build.yml + +on: + push: + branches: + - '**' + tags: + - '*' + pull_request: + branches: + - master + +defaults: + run: + # This otherwise gets run under dash which does not support brace expansion + shell: bash + +jobs: + # We'll only package the plugins with an entry in bundler.toml + package: + strategy: + matrix: + include: + - { name: ubuntu-20.04, os: ubuntu-20.04, cross-target: '' } + - { name: macos-universal, os: macos-11, cross-target: aarch64-apple-darwin } + - { name: windows, os: windows-latest, cross-target: '' } + name: Package plugin binaries + runs-on: ${{ matrix.os }} + steps: + - uses: actions/checkout@v3 + - name: Fetch all git history + run: git fetch --force --prune --tags --unshallow + + - name: Install dependencies + if: startsWith(matrix.os, 'ubuntu') + run: | + sudo apt-get update + sudo apt-get install -y libasound2-dev libgl-dev libjack-dev libx11-xcb-dev libxcb1-dev libxcb-dri2-0-dev libxcb-icccm4-dev libxcursor-dev libxkbcommon-dev libxcb-shape0-dev libxcb-xfixes0-dev + + - uses: actions/cache@v3 + # FIXME: Caching `target/` causes the Windows runner to blow up after some time + if: startsWith(matrix.os, 'windows') + with: + path: | + ~/.cargo/registry/index/ + ~/.cargo/registry/cache/ + ~/.cargo/git/db/ + key: ${{ matrix.name }}-${{ matrix.cross-target }} + - uses: actions/cache@v3 + if: "!startsWith(matrix.os, 'windows')" + with: + path: | + ~/.cargo/registry/index/ + ~/.cargo/registry/cache/ + ~/.cargo/git/db/ + target/ + key: ${{ matrix.name }}-${{ matrix.cross-target }} + + - name: Set up Rust toolchain + # Needed for SIMD + uses: dtolnay/rust-toolchain@nightly + with: + # The macOS AArch64 build is done from an x86_64 macOS CI runner, so + # it needs to be cross compiled + targets: ${{ matrix.cross-target }} + - name: Package all targets from bundler.toml + # Instead of hardcoding which targets to build and package, we'll + # package everything that's got en entry in the `bundler.toml` file + run: | + # Building can be sped up by specifying all packages in one go + package_args=() + for package in $(cargo xtask known-packages); do + package_args+=("-p" "$package") + done + + runner_name=${{ matrix.name }} + if [[ $runner_name = 'macos-universal' ]]; then + export MACOSX_DEPLOYMENT_TARGET=10.13 + cargo xtask bundle-universal "${package_args[@]}" --release + else + cross_target=${{ matrix.cross-target }} + if [[ -n $cross_target ]]; then + package_args+=("--target" "$cross_target") + fi + + cargo xtask bundle "${package_args[@]}" --release + fi + + - name: Determine build archive name + run: | + # Windows (usually) doesn't like colons in file names + echo "ARCHIVE_NAME=lamb-$(date -u +"%Y-%m-%d-%H%m%S")-${{ matrix.name }}" >> "$GITHUB_ENV" + - name: Move all packaged plugin into a directory + run: | + # GitHub Action strips the top level directory, great, have another one + mkdir -p "$ARCHIVE_NAME/$ARCHIVE_NAME" + mv target/bundled/* "$ARCHIVE_NAME/$ARCHIVE_NAME" + - name: Add an OS-specific readme file with installation instructions + run: cp ".github/workflows/readme-${{ runner.os }}.txt" "$ARCHIVE_NAME/$ARCHIVE_NAME/README.txt" + - uses: actions/upload-artifact@v3 + with: + name: ${{ env.ARCHIVE_NAME }} + path: ${{ env.ARCHIVE_NAME }} diff --git a/.github/workflows/readme-Linux.txt b/.github/workflows/readme-Linux.txt new file mode 100644 index 0000000..1a2f474 --- /dev/null +++ b/.github/workflows/readme-Linux.txt @@ -0,0 +1,10 @@ +To install the VST3 plugins, copy the .vst3 _directories_ to: +~/.vst3 + +To install the CLAP plugins, copy the .clap files to: +~/.clap + +You will need to create these directories yourself it they do not yet exist. + +See https://github.com/free-audio/clap#hosts for instructions on how to enable +CLAP support in your DAW. diff --git a/.github/workflows/readme-Windows.txt b/.github/workflows/readme-Windows.txt new file mode 100644 index 0000000..611fdb3 --- /dev/null +++ b/.github/workflows/readme-Windows.txt @@ -0,0 +1,10 @@ +To install the VST3 plugins, copy the .vst3 _directories_ to: +C:/Program Files/Common Files/VST3/ + +To install the CLAP plugins, copy the .clap files to: +C:/Program Files/Common Files/CLAP/ + +You will need to create these directories yourself it they do not yet exist. + +See https://github.com/free-audio/clap#hosts for instructions on how to enable +CLAP support in your DAW. diff --git a/.github/workflows/readme-macOS.txt b/.github/workflows/readme-macOS.txt new file mode 100644 index 0000000..d62ea6d --- /dev/null +++ b/.github/workflows/readme-macOS.txt @@ -0,0 +1,15 @@ +You may need to disable Gatekeeper on macOS to be able to use the plugins: +https://disable-gatekeeper.github.io/ + +--- + +To install the VST3 plugins, copy the .vst3 bundles to: +~/Library/Audio/Plug-Ins/VST3 + +To install the CLAP plugins, copy the .clap bundles to: +~/Library/Audio/Plug-Ins/CLAP + +You will need to create these directories yourself it they do not yet exist. + +See https://github.com/free-audio/clap#hosts for instructions on how to enable +CLAP support in your DAW.