GitHub
本指南将向你展示如何在 GitHub Actions 中使用 tauri-action 来轻松构建和上传你的应用,以及如何使 Tauri 的更新程序查询新创建的 GitHub 发布以获取更新。
🌐 This guide will show you how to use tauri-action in GitHub Actions to easily build and upload your app, and how to make Tauri’s updater query the newly created GitHub release for updates.
最后,它还将展示如何为 Linux Arm AppImages 设置更复杂的构建管道。
🌐 Lastly, it will also show how to set up a more complicated build pipeline for Linux Arm AppImages.
🌐 Getting Started
要设置 tauri-action,你必须首先设置一个 GitHub 仓库。你也可以在尚未配置 Tauri 的仓库上使用此操作,因为它可以为你自动初始化 Tauri,请参阅 action 的自述文件 以获取必要的配置选项。
🌐 To set up tauri-action you must first set up a GitHub repository. You can also use this action on a repository that does not have Tauri configured yet since it can automatically initialize Tauri for you, please see the action’s readme for necessary configuration options.
转到你的 GitHub 项目页面上的“Actions”选项卡,然后选择“New workflow”,接着选择“Set up a workflow yourself”。用下面的工作流程(下面)或其中一个动作示例替换该文件。
🌐 Go to the Actions tab on your GitHub project page and select “New workflow”, then choose “Set up a workflow yourself”. Replace the file with the workflow from below or from one of the action’s examples.
🌐 Configuration
请参阅 tauri-action 自述文件 以了解所有可用的配置选项。
🌐 Please see the tauri-action readme for all available configuration options.
当你的应用不在仓库根目录时,请使用 projectPath 输入。
🌐 When your app is not on the root of the repository, use the projectPath input.
你可以自由修改工作流名称,更改其触发条件,并添加更多步骤,例如 npm run lint 或 npm run test。重要的是,你必须将以下行保留在工作流的末尾,因为它会运行构建脚本并发布你的应用。
🌐 You may freely modify the workflow name, change its triggers, and add more steps such as npm run lint or npm run test. The important part is that you keep the below line at the end of the workflow since this runs the build script and releases your app.
🌐 How to Trigger
下面显示的发布工作流程以及 tauri-action 示例中所示的工作流程,是由推送到 release 分支触发的。该操作会自动使用应用版本创建 git 标签和 GitHub 发布的标题。
🌐 The release workflow shown below and in the tauri-action examples is triggered by pushed to the release branch. The action automatically creates a git tag and a title for the GitHub release using the application version.
作为另一个例子,你也可以更改触发器,使工作流在推送版本 git 标签(如 app-v0.7.0)时运行:
🌐 As another example, you can also change the trigger to run the workflow on the push of a version git tag such as app-v0.7.0:
name: 'publish'
on: push: tags: - 'app-v*'有关所有可能触发器配置的完整列表,请查看官方GitHub 文档。
🌐 For a full list of possible trigger configurations, check out the official GitHub documentation.
🌐 Example Workflow
下面是一个示例工作流程,每次你推送到 release 分支时都会运行。
🌐 Below is an example workflow that has been set up to run every time you push to the release branch.
此工作流程将为 Windows x64、Linux x64、Linux Arm64、macOS x64 和 macOS Arm64(M1 及更高版本)构建和发布你的应用。
🌐 This workflow will build and release your app for Windows x64, Linux x64, Linux Arm64, macOS x64 and macOS Arm64 (M1 and above).
此工作流程采取的步骤如下:
🌐 The steps this workflow takes are:
- 使用
actions/checkout@v4检出仓库。 - 安装构建应用所需的 Linux 系统依赖。
- 使用
actions/setup-node@v4设置 Node.js LTS 版本以及全局 npm/yarn/pnpm 包数据缓存。 - 使用
dtolnay/rust-toolchain@stable和swatinem/rust-cache@v2设置 Rust 以及 Rust 构建产物的缓存。 - 安装前端依赖,如果没有配置为
beforeBuildCommand,请运行 Web 应用的构建脚本。 - 最后,它使用
tauri-apps/tauri-action@v0来运行tauri build,生成工件,并创建一个 GitHub 发布。
name: 'publish'
on: workflow_dispatch: push: branches: - release
jobs: publish-tauri: permissions: contents: write strategy: fail-fast: false matrix: include: - platform: 'macos-latest' # for Arm based macs (M1 and above). args: '--target aarch64-apple-darwin' - platform: 'macos-latest' # for Intel based macs. args: '--target x86_64-apple-darwin' - platform: 'ubuntu-22.04' args: '' - platform: 'ubuntu-22.04-arm' # Only available in public repos. args: '' - platform: 'windows-latest' args: ''
runs-on: ${{ matrix.platform }} steps: - uses: actions/checkout@v4
- name: install dependencies (ubuntu only) if: matrix.platform == 'ubuntu-22.04' || matrix.platform == 'ubuntu-22.04-arm' # This must match the platform value defined above. run: | sudo apt-get update sudo apt-get install -y libwebkit2gtk-4.1-dev libappindicator3-dev librsvg2-dev patchelf
- name: setup node uses: actions/setup-node@v4 with: node-version: lts/* cache: 'yarn' # Set this to npm, yarn or pnpm.
- name: install Rust stable uses: dtolnay/rust-toolchain@stable # Set this to dtolnay/rust-toolchain@nightly with: # Those targets are only used on macos runners so it's in an `if` to slightly speed up windows and linux builds. targets: ${{ matrix.platform == 'macos-latest' && 'aarch64-apple-darwin,x86_64-apple-darwin' || '' }}
- name: Rust cache uses: swatinem/rust-cache@v2 with: workspaces: './src-tauri -> target'
- name: install frontend dependencies # If you don't have `beforeBuildCommand` configured you may want to build your frontend here too. run: yarn install # change this to npm or pnpm depending on which one you use.
- uses: tauri-apps/tauri-action@v0 env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} with: tagName: app-v__VERSION__ # the action automatically replaces \_\_VERSION\_\_ with the app version. releaseName: 'App v__VERSION__' releaseBody: 'See the assets to download this version and install.' releaseDraft: true prerelease: false args: ${{ matrix.args }}有关更多配置选项,请查看 tauri-action 仓库及其 示例。
🌐 For more configuration options, check out the tauri-action repository and its examples.
🌐 Arm Runner Compilation
此工作流使用 pguyot/arm-runner-action 在模拟的 Arm 运行器上直接进行编译。这弥补了 AppImage 工具中缺少跨架构构建支持的空白。
🌐 This workflow uses pguyot/arm-runner-action to compile directly on an emulated Arm runner. This bridges the gap for missing cross-architecture build support in the AppImage tooling.
name: 'Publish Linux Arm builds'
on: workflow_dispatch: push: branches: - release
jobs: build: runs-on: ubuntu-22.04
strategy: matrix: arch: [aarch64, armv7l] include: - arch: aarch64 cpu: cortex-a72 base_image: https://dietpi.com/downloads/images/DietPi_RPi5-ARMv8-Bookworm.img.xz deb: arm64 rpm: aarch64 appimage: aarch64 - arch: armv7l cpu: cortex-a53 deb: armhfp rpm: arm appimage: armhf base_image: https://dietpi.com/downloads/images/DietPi_RPi-ARMv7-Bookworm.img.xz
steps: - uses: actions/checkout@v3
- name: Cache rust build artifacts uses: Swatinem/rust-cache@v2 with: workspaces: src-tauri cache-on-failure: true
- name: Build app uses: pguyot/arm-runner-action@v2.6.5 with: base_image: ${{ matrix.base_image }} cpu: ${{ matrix.cpu }} bind_mount_repository: true image_additional_mb: 10240 optimize_image: no #exit_on_fail: no commands: | # Prevent Rust from complaining about $HOME not matching eid home export HOME=/root
# Workaround to CI worker being stuck on Updating crates.io index export CARGO_REGISTRIES_CRATES_IO_PROTOCOL=sparse
# Install setup prerequisites apt-get update -y --allow-releaseinfo-change apt-get autoremove -y apt-get install -y --no-install-recommends --no-install-suggests curl libwebkit2gtk-4.1-dev build-essential libssl-dev libgtk-3-dev libayatana-appindicator3-dev librsvg2-dev patchelf libfuse2 file curl https://sh.rustup.rs -sSf | sh -s -- -y . "$HOME/.cargo/env" curl -fsSL https://deb.nodesource.com/setup_lts.x | bash apt-get install -y nodejs
# Install frontend dependencies npm install
# Build the application npm run tauri build -- --verbose
- name: Get app version run: echo "APP_VERSION=$(jq -r .version src-tauri/tauri.conf.json)" >> $GITHUB_ENV
# TODO: Combine this with the basic workflow and upload the files to the Release. - name: Upload deb bundle uses: actions/upload-artifact@v3 with: name: Debian Bundle path: ${{ github.workspace }}/src-tauri/target/release/bundle/deb/appname_${{ env.APP_VERSION }}_${{ matrix.deb }}.deb
- name: Upload rpm bundle uses: actions/upload-artifact@v3 with: name: RPM Bundle path: ${{ github.workspace }}/src-tauri/target/release/bundle/rpm/appname-${{ env.APP_VERSION }}-1.${{ matrix.rpm }}.rpm
- name: Upload appimage bundle uses: actions/upload-artifact@v3 with: name: AppImage Bundle path: ${{ github.workspace }}/src-tauri/target/release/bundle/appimage/appname_${{ env.APP_VERSION }}_${{ matrix.appimage }}.AppImage🌐 Troubleshooting
🌐 GitHub Environment Token
GitHub 令牌由 GitHub 自动为每次工作流运行发放,无需进一步配置,这意味着没有秘密泄露的风险。然而,该令牌默认情况下仅具有读取权限,在运行工作流时可能会遇到“集成无法访问资源”的错误。如果发生这种情况,你可能需要为该令牌添加写入权限。为此,请进入你的 GitHub 项目设置,选择 Actions,向下滚动到 Workflow permissions,并勾选“读写权限”。
🌐 The GitHub Token is automatically issued by GitHub for each workflow run without further configuration, which means there is no risk of secret leakage. This token however only has read permissions by default and you may get a “Resource not accessible by integration” error when running the workflow. If this happens, you may need to add write permissions to this token. To do this, go to your GitHub project settings, select Actions, scroll down to Workflow permissions, and check “Read and write permissions”.
你可以通过工作流中的此行看到 GitHub Token 被传递给工作流:
🌐 You can see the GitHub Token being passed to the workflow via this line in the workflow:
env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}Tauri 中文网 - 粤ICP备13048890号
Nodejs.cn 旗下网站