Release #7
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: Release | |
| on: | |
| # Trigger this workflow when a tag is pushed in the format `v1.2.3`. | |
| push: | |
| tags: | |
| # Pattern syntax: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet | |
| - "v[0-9]+.[0-9]+.[0-9]+*" | |
| # Trigger this workflow manually via workflow dispatch. | |
| workflow_dispatch: | |
| inputs: | |
| version: | |
| description: 'Version number in the format `v1.2.3`' | |
| required: true | |
| type: string | |
| # Configure constants for this workflow. | |
| env: | |
| # TODO: This may become unnecessary: https://github.com/rust-lang/cargo/issues/6790 | |
| # The base filename of the binary produced by `cargo build`. | |
| BINARY: run | |
| # The name to use for the packaged application produced by this workflow. | |
| PACKAGE_NAME: bevy_jam_5 | |
| # The itch.io page to upload to in the format `user-name/project-name`. | |
| # Comment this out to disable. | |
| ITCH_TARGET: pyrious/bevy-jam-5 | |
| # The organization or author that owns the rights to the game. | |
| OWNER: Pyrious, ramirezmike, Eden | |
| # The path to the assets directory. | |
| ASSETS_DIR: assets | |
| # Whether packages produced by this workflow should be uploaded to the Github release. | |
| UPLOAD_PACKAGES_TO_GITHUB_RELEASE: true | |
| # Before enabling LFS, please take a look at GitHub's documentation for costs and quota limits: | |
| # https://docs.github.com/en/repositories/working-with-files/managing-large-files/about-storage-and-bandwidth-usage | |
| USE_GIT_LFS: false | |
| jobs: | |
| # Determine the version number for this workflow. | |
| get-version: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Get version number from tag | |
| id: tag | |
| run: echo "tag=${GITHUB_REF#refs/tags/}" >> "${GITHUB_OUTPUT}" | |
| outputs: | |
| version: ${{ inputs.version || steps.tag.outputs.tag }} | |
| # Build and package a release for each platform. | |
| build: | |
| needs: | |
| - get-version | |
| env: | |
| VERSION: ${{ needs.get-version.outputs.version }} | |
| strategy: | |
| matrix: | |
| include: | |
| - platform: web | |
| targets: wasm32-unknown-unknown | |
| profile: wasm-release | |
| features: web | |
| binary_ext: .wasm | |
| package_ext: .zip | |
| runner: ubuntu-latest | |
| - platform: linux | |
| targets: x86_64-unknown-linux-gnu | |
| profile: release | |
| features: native,bevy/wayland | |
| package_ext: .zip | |
| runner: ubuntu-latest | |
| - platform: windows | |
| targets: x86_64-pc-windows-msvc | |
| profile: release | |
| features: native | |
| binary_ext: .exe | |
| package_ext: .zip | |
| runner: windows-latest | |
| - platform: macos | |
| targets: x86_64-apple-darwin aarch64-apple-darwin | |
| profile: release | |
| features: native | |
| out_dir_suffix: .app/Contents/MacOS | |
| package_ext: .dmg | |
| runner: macos-latest | |
| runs-on: ${{ matrix.runner }} | |
| defaults: | |
| run: | |
| shell: bash | |
| steps: | |
| - name: Set up environment | |
| run: | | |
| echo 'PACKAGE=${{ env.PACKAGE_NAME }}-${{ matrix.platform }}' >> "${GITHUB_ENV}" | |
| echo 'OUT_DIR=tmp/package/${{ env.PACKAGE_NAME }}${{ matrix.out_dir_suffix }}' >> "${GITHUB_ENV}" | |
| if [ '${{ matrix.platform }}' == 'macos' ]; then | |
| echo 'MACOSX_DEPLOYMENT_TARGET=11.0' >> "${GITHUB_ENV}" # MacOS 11.0 Big Sur is the first version to support universal binaries. | |
| echo "SDKROOT=$(xcrun --sdk macosx --show-sdk-path)" >> "${GITHUB_ENV}" | |
| fi | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| with: | |
| lfs: ${{ env.USE_GIT_LFS }} | |
| - name: Install Rust toolchain | |
| uses: dtolnay/rust-toolchain@stable | |
| with: | |
| targets: ${{ matrix.targets }} | |
| - name: Populate target directory from cache | |
| uses: Leafwing-Studios/cargo-cache@v2 | |
| - name: Install dependencies (Linux) | |
| if: ${{ matrix.platform == 'linux' }} | |
| run: sudo apt-get update; sudo apt-get install --no-install-recommends libasound2-dev libudev-dev libwayland-dev libxkbcommon-dev | |
| - name: Prepare output directories | |
| run: rm -rf tmp; mkdir -p tmp/binary '${{ env.OUT_DIR }}' | |
| - name: Build binaries | |
| run: | | |
| for target in ${{ matrix.targets }}; do | |
| cargo build --profile='${{ matrix.profile }}' --target="${target}" --no-default-features --features='${{ matrix.features }}' | |
| mv target/"${target}"/'${{ matrix.profile }}/${{ env.BINARY }}${{ matrix.binary_ext }}' tmp/binary/"${target}"'${{ matrix.binary_ext }}' | |
| done | |
| - name: Install cargo-binstall (Web) | |
| if: ${{ matrix.platform == 'web' }} | |
| uses: cargo-bins/[email protected] | |
| - name: Run wasm-bindgen (Web) | |
| if: ${{ matrix.platform == 'web' }} | |
| run: | | |
| cargo binstall --no-confirm wasm-bindgen-cli | |
| mkdir -p tmp/bindgen | |
| wasm-bindgen tmp/binary/*'${{ matrix.binary_ext }}' --out-dir tmp/bindgen --out-name '${{ env.PACKAGE_NAME }}' --no-typescript --target web | |
| rm -rf tmp/binary; mv tmp/bindgen tmp/binary | |
| - name: Optimize Wasm (Web) | |
| if: ${{ matrix.platform == 'web' }} | |
| uses: NiklasEi/wasm-opt-action@v2 | |
| with: | |
| file: tmp/binary/*${{ matrix.binary_ext }} | |
| - name: Add binaries to package | |
| run: | | |
| if [ '${{ matrix.platform }}' == 'macos' ]; then | |
| lipo tmp/binary/*'${{ matrix.binary_ext }}' -create -output '${{ env.OUT_DIR }}/${{ env.PACKAGE_NAME }}${{ matrix.binary_ext }}' | |
| elif [ '${{ matrix.platform }}' == 'web' ]; then | |
| mv tmp/binary/*'${{ matrix.binary_ext }}' '${{ env.OUT_DIR }}/${{ env.PACKAGE_NAME }}_bg${{ matrix.binary_ext }}' | |
| else | |
| mv tmp/binary/*'${{ matrix.binary_ext }}' '${{ env.OUT_DIR }}/${{ env.PACKAGE_NAME }}${{ matrix.binary_ext }}' | |
| fi | |
| mv tmp/binary/* '${{ env.OUT_DIR }}' || true # Ignore error if there's nothing left to move | |
| - name: Add assets to package | |
| run: cp -r '${{ env.ASSETS_DIR }}' '${{ env.OUT_DIR }}' || true # Ignore error if there's nothing to copy | |
| - name: Add web content to package (Web) | |
| if: ${{ matrix.platform == 'web' }} | |
| run: cp -r web/* '${{ env.OUT_DIR }}' | |
| - name: Add app metadata to package (MacOS) | |
| if: ${{ matrix.platform == 'macos' }} | |
| run: | | |
| cat >'${{ env.OUT_DIR }}/../Info.plist' <<EOF | |
| <?xml version="1.0" encoding="UTF-8"?> | |
| <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"> | |
| <plist version="1.0"> | |
| <dict> | |
| <key>CFBundleDevelopmentRegion</key> | |
| <string>en</string> | |
| <key>CFBundleDisplayName</key> | |
| <string>${{ env.PACKAGE_NAME }}</string> | |
| <key>CFBundleExecutable</key> | |
| <string>${{ env.PACKAGE_NAME }}</string> | |
| <key>CFBundleIdentifier</key> | |
| <string>${{ env.OWNER }}.${{ env.PACKAGE_NAME }}</string> | |
| <key>CFBundleName</key> | |
| <string>${{ env.PACKAGE_NAME }}</string> | |
| <key>CFBundleShortVersionString</key> | |
| <string>${{ env.VERSION }}</string> | |
| <key>CFBundleVersion</key> | |
| <string>${{ env.VERSION }}</string> | |
| <key>CFBundleInfoDictionaryVersion</key> | |
| <string>6.0</string> | |
| <key>CFBundlePackageType</key> | |
| <string>APPL</string> | |
| <key>CFBundleSupportedPlatforms</key> | |
| <array> | |
| <string>MacOSX</string> | |
| </array> | |
| </dict> | |
| </plist> | |
| EOF | |
| - name: Finish package (non-Windows) | |
| if: ${{ matrix.platform != 'windows' }} | |
| working-directory: tmp/package | |
| run: | | |
| if [ '${{ matrix.platform }}' == 'macos' ]; then | |
| ln -s /Applications . | |
| hdiutil create -fs HFS+ -volname '${{ env.PACKAGE_NAME }}' -srcfolder . '${{ env.PACKAGE }}${{ matrix.package_ext }}' | |
| else | |
| zip --recurse-paths '${{ env.PACKAGE }}${{ matrix.package_ext }}' '${{ env.PACKAGE_NAME }}' | |
| fi | |
| - name: Finish package (Windows) | |
| if: ${{ matrix.platform == 'windows' }} | |
| working-directory: tmp/package | |
| shell: pwsh | |
| run: Compress-Archive -Path '${{ env.PACKAGE_NAME }}' -DestinationPath '${{ env.PACKAGE }}${{ matrix.package_ext }}' | |
| - name: Upload package to artifacts | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| path: tmp/package/${{ env.PACKAGE }}${{ matrix.package_ext }} | |
| name: package-${{ matrix.platform }} | |
| retention-days: 1 | |
| - name: Upload package to Github release | |
| if: ${{ env.UPLOAD_PACKAGES_TO_GITHUB_RELEASE == 'true' }} | |
| uses: svenstaro/upload-release-action@v2 | |
| with: | |
| repo_token: ${{ secrets.GITHUB_TOKEN }} | |
| file: tmp/package/${{ env.PACKAGE }}${{ matrix.package_ext }} | |
| asset_name: ${{ env.PACKAGE }}${{ matrix.package_ext }} | |
| release_name: ${{ env.VERSION }} | |
| tag: ${{ env.VERSION }} | |
| overwrite: true | |
| # Get itch.io target from env, because the `env` context can't be used in the `if:` condition of a job. | |
| # See: https://docs.github.com/en/actions/learn-github-actions/contexts#context-availability | |
| get-itch-target: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Do nothing | |
| run: 'true' | |
| outputs: | |
| itch-target: ${{ env.ITCH_TARGET }} | |
| # Upload all packages to itch.io. | |
| upload-to-itch: | |
| runs-on: ubuntu-latest | |
| needs: | |
| - get-version | |
| - get-itch-target | |
| - build | |
| if: ${{ needs.get-itch-target.outputs.itch-target != '' }} | |
| steps: | |
| - name: Download all packages | |
| uses: actions/download-artifact@v4 | |
| with: | |
| pattern: package-* | |
| path: tmp | |
| - name: Install butler | |
| run: | | |
| curl -L -o butler.zip 'https://broth.itch.ovh/butler/linux-amd64/LATEST/archive/default' | |
| unzip butler.zip | |
| chmod +x butler | |
| ./butler -V | |
| - name: Upload all packages to itch.io | |
| env: | |
| BUTLER_API_KEY: ${{ secrets.BUTLER_CREDENTIALS }} | |
| run: | | |
| for channel in $(ls tmp); do | |
| ./butler push \ | |
| --fix-permissions \ | |
| --userversion='${{ needs.get-version.outputs.version }}' \ | |
| tmp/"${channel}"/* \ | |
| '${{ env.ITCH_TARGET }}':"${channel#package-}" | |
| done |